Skip to content

Fix: Update readme file and refactored test files to pass CI test #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)
![Release](https://img.shields.io/badge/Release-v1.0.1-426B20)
![Build](https://img.shields.io/badge/Build-Passing-brightgreen.svg)
![Coverage](https://img.shields.io/badge/Coverage-87%25-c7ea46.svg)
![Coverage](https://img.shields.io/badge/Coverage-89%25-c7ea46.svg)
[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](/CONTRIBUTING.md)

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

**Note:** <i>MLflow.js</i> is a community-maintained project and is **not** affiliated with or endorsed by Databricks or the official MLflow maintainers.

<br>

## Features
Expand Down Expand Up @@ -53,11 +55,19 @@ Ensure MLflow is installed on your system:
pip install mlflow
```

**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`.
For MacOS users, we recommend creating and activating a Python virtual environment to avoid common installation issues and keep dependencies isolated:

```bash
python3 -m venv mlflow-venv
source mlflow-venv/bin/activate
pip install mlflow
```

Remember to activate your virtual environment (`source mlflow-venv/bin/activate`) each time you open a new terminal before running MLflow commands.

### Start the MLflow Tracking Server

To start the MLflow tracking server locally, use the following command:
After activating the virtual environment, start the MLflow tracking server locally, use the following command:

```bash
mlflow ui --port 5001
Expand Down Expand Up @@ -157,7 +167,7 @@ Official documentation for <i>MLflow.js</i> can be found <a href="https://www.ml

## Contributing

We welcome contributions to <i>MLflow.js</i>! Please see our [Contributing Guide](/CONTRIBUTING.md) for more details on how to get started.
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.

<br>

Expand Down
4 changes: 0 additions & 4 deletions mlflow/lib/tracking/ExperimentClient.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion mlflow/lib/tracking/ExperimentClient.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions mlflow/lib/workflows/ExperimentManager.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion mlflow/lib/workflows/ExperimentManager.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion mlflow/src/tracking/RunClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,10 @@ class RunClient {
);
}

return data;
return {
metrics: data.metrics || [],
next_page_token: data.next_page_token,
};
}

/**
Expand Down
Loading