You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-5Lines changed: 44 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,47 @@
1
1
# Pipeline Library
2
2
3
-
The purpose of this library is to create pipelines for ML as simple as possible. At the moment we support XGBoost models, but we are working to support more models.
3
+
The Pipeline Library is designed to simplify the creation of machine learning pipelines. Currently, it supports XGBoost models, with plans to expand support for more models in the future.
4
4
5
-
This is an example of how to use the library to run an XGBoost pipeline:
5
+
## Installation
6
+
7
+
To install the Pipeline Library, you need to have Python 3.9 or higher and Poetry installed. Follow these steps:
If you want to include optional dependencies, you can specify the extras:
28
+
29
+
```bash
30
+
poetry install --extras "xgboost"
31
+
```
32
+
33
+
or
34
+
35
+
```bash
36
+
poetry install --extras "all_models"
37
+
```
38
+
39
+
## Usage
40
+
41
+
Here's an example of how to use the library to run an XGBoost pipeline:
42
+
43
+
1. Create a `train.json` file with the following content:
6
44
7
-
We create a `train.json` file with the following content:
8
45
9
46
```json
10
47
{
@@ -57,7 +94,7 @@ We create a `train.json` file with the following content:
57
94
}
58
95
```
59
96
60
-
The user can define custom steps to generate and clean their own data and use them in the pipeline. Then we can run the pipeline with the following code:
97
+
2. Run the pipeline using the following code:
61
98
62
99
```python
63
100
import logging
@@ -67,4 +104,6 @@ from pipeline_lib.core import Pipeline
67
104
logging.basicConfig(level=logging.INFO)
68
105
69
106
Pipeline.from_json("train.json").run()
70
-
```
107
+
```
108
+
109
+
The library allows users to define custom steps for generating and cleaning their own data, which can be used in the pipeline.
0 commit comments