Skip to content

Commit 8d91815

Browse files
committed
improve readme
1 parent 14e05b9 commit 8d91815

File tree

1 file changed

+44
-5
lines changed

1 file changed

+44
-5
lines changed

README.md

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,47 @@
11
# Pipeline Library
22

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.
44

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:
8+
9+
1. Clone the repository:
10+
11+
```bash
12+
git clone https://github.com/tryolabs/pipeline-lib.git
13+
```
14+
15+
2. Navigate to the project directory:
16+
17+
```bash
18+
cd pipeline-lib
19+
```
20+
21+
3. Install the dependencies using Poetry:
22+
23+
```bash
24+
poetry install
25+
```
26+
27+
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:
644
7-
We create a `train.json` file with the following content:
845
946
```json
1047
{
@@ -57,7 +94,7 @@ We create a `train.json` file with the following content:
5794
}
5895
```
5996
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:
6198
6299
```python
63100
import logging
@@ -67,4 +104,6 @@ from pipeline_lib.core import Pipeline
67104
logging.basicConfig(level=logging.INFO)
68105
69106
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

Comments
 (0)