Skip to content

Commit

Permalink
fix: update readme with optional mlflow dependency
Browse files Browse the repository at this point in the history
Signed-off-by: Avik Basu <avikbasu93@gmail.com>
  • Loading branch information
ab93 committed Oct 18, 2022
1 parent 6a391ba commit 5703d1b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,16 @@ the result further or drop it after a trigger request.

## Installation

numalogic can be installed using pip.
```shell
pip install numalogic
```

If using mlflow for model registry, install using:
```shell
pip install numalogic[mlflow]
```

### Build locally

1. Install [Poetry](https://python-poetry.org/docs/):
Expand All @@ -53,13 +59,17 @@ pip install numalogic
```
poetry install
```
If extra dependencies are needed:
```
poetry install --all-extras
```
4. To run unit tests:
```
make test
```
5. To format code style using black:
```
make format
make lint
```

## Usage
Expand Down Expand Up @@ -133,7 +143,7 @@ Now that the model is trained, let's save it. Numalogic has built in support
for Mlflow's tracking and logging system.

Let's first start the [mlflow server on localhost](https://www.mlflow.org/docs/latest/tracking.html#scenario-1-mlflow-on-localhost),
which has already been installed via `poetry` dependency:
which has already been installed optionally via `poetry` dependency:
```shell
mlflow server \
--default-artifact-root {directory}/mlruns --serve-artifacts \
Expand Down

0 comments on commit 5703d1b

Please sign in to comment.