|
8 | 8 | [](/LICENSE) |
9 | 9 |  |
10 | 10 |  |
11 | | - |
| 11 | + |
12 | 12 | [](/CONTRIBUTING.md) |
13 | 13 |
|
14 | 14 | <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. |
15 | 15 |
|
| 16 | +**Note:** <i>MLflow.js</i> is a community-maintained project and is **not** affiliated with or endorsed by Databricks or the official MLflow maintainers. |
| 17 | + |
16 | 18 | <br> |
17 | 19 |
|
18 | 20 | ## Features |
@@ -53,11 +55,19 @@ Ensure MLflow is installed on your system: |
53 | 55 | pip install mlflow |
54 | 56 | ``` |
55 | 57 |
|
56 | | -**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`. |
| 58 | +For MacOS users, we recommend creating and activating a Python virtual environment to avoid common installation issues and keep dependencies isolated: |
| 59 | + |
| 60 | +```bash |
| 61 | +python3 -m venv mlflow-venv |
| 62 | +source mlflow-venv/bin/activate |
| 63 | +pip install mlflow |
| 64 | +``` |
| 65 | + |
| 66 | +Remember to activate your virtual environment (`source mlflow-venv/bin/activate`) each time you open a new terminal before running MLflow commands. |
57 | 67 |
|
58 | 68 | ### Start the MLflow Tracking Server |
59 | 69 |
|
60 | | -To start the MLflow tracking server locally, use the following command: |
| 70 | +After activating the virtual environment, start the MLflow tracking server locally, use the following command: |
61 | 71 |
|
62 | 72 | ```bash |
63 | 73 | mlflow ui --port 5001 |
@@ -157,7 +167,7 @@ Official documentation for <i>MLflow.js</i> can be found <a href="https://www.ml |
157 | 167 |
|
158 | 168 | ## Contributing |
159 | 169 |
|
160 | | -We welcome contributions to <i>MLflow.js</i>! Please see our [Contributing Guide](/CONTRIBUTING.md) for more details on how to get started. |
| 170 | +We welcome contributions to <i>MLflow.js</i>! Please note that this library is maintained by independent community contributors, not the MLflow core team or Databricks. See our [Contributing Guide](/CONTRIBUTING.md) for more details on how to get started. |
161 | 171 |
|
162 | 172 | <br> |
163 | 173 |
|
|
0 commit comments