Skip to content

Commit 8d22580

Browse files
committed
update mlflow installations to recommend Python virtual env
1 parent 3976f38 commit 8d22580

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)
99
![Release](https://img.shields.io/badge/Release-v1.0.1-426B20)
1010
![Build](https://img.shields.io/badge/Build-Passing-brightgreen.svg)
11-
![Coverage](https://img.shields.io/badge/Coverage-87%25-c7ea46.svg)
11+
![Coverage](https://img.shields.io/badge/Coverage-89%25-c7ea46.svg)
1212
[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](/CONTRIBUTING.md)
1313

1414
<i>MLflow.js</i> is an open-source JavaScript library that helps developers track machine learning experiments and manage models with MLflow, providing functionalities for machine learning lifecycle in JavaScript/TypeScript environments.
@@ -49,17 +49,21 @@
4949

5050
### Set Up MLflow
5151

52-
Ensure MLflow is installed on your system:
52+
Ensure MLflow is installed on your system. To avoid common installation issues and keep dependencies isolated, create and activate a Python virtual environment as follows:
5353

5454
```bash
55+
python3 -m venv mlflow-venv
56+
source mlflow-venv/bin/activate
5557
pip install mlflow
5658
```
5759

5860
**Note:** MLflow is compatible with MacOS. If you encounter issues with the default system Python, consider installing Python 3 via the Homebrew package manger using `brew install python`. In this case, installing MLflow is now `pip3 install mlflow`.
5961

62+
Remember to activate your virtual environment (`source mlflow-venv/bin/activate`) each time you open a new terminal before running MLflow commands.
63+
6064
### Start the MLflow Tracking Server
6165

62-
To start the MLflow tracking server locally, use the following command:
66+
After activating the virtual environment, start the MLflow tracking server locally, use the following command:
6367

6468
```bash
6569
mlflow ui --port 5001

0 commit comments

Comments
 (0)