Skip to content

Commit 588eb1d

Browse files
seneyuseneyu
committed
Add logo with white bg, update features in readme, add contributing file
1 parent cadcd6a commit 588eb1d

File tree

3 files changed

+51
-54
lines changed

3 files changed

+51
-54
lines changed

‎CONTRIBUTING.md‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
## Contributing
1+
# Contribution Guidelines
22

33
We are always open to accepting any potential contributions. Here is how you can contribute:
44

55
1. Fork the repository
66
2. Clone your forked repository
77

88
```bash
9-
git clone https://github.com/your-username/respository-name.git
9+
git clone https://github.com/your-username/repository-name.git
1010
```
1111

12-
3. Install dependencies for both mlflow and mlfow-site directories
12+
3. Install dependencies for both mlflow and mlflow-site directories
1313

1414
```bash
1515
cd mlflow && npm install
@@ -30,24 +30,33 @@ git checkout -b feature/AmazingFeature
3030

3131
6. Make your changes
3232

33-
7. Run tests to ensure your changes don't break existing functionality
33+
7. Run ESLint to check code style
3434

35-
(Make sure you have mlflow UI server running on port 5002: `mlflow ui --port 5002`)
35+
```bash
36+
npm run lint
37+
```
38+
39+
8. Run tests to ensure your changes don't break existing functionality
40+
41+
(Make sure you have mlflow UI server running on port 5002. We set 5002 as our default port for testing.)
3642

3743
```bash
44+
mlflow ui --port 5002 # Run this in a separate terminal
3845
npm run test
3946
```
4047

41-
8. Commit your changes
48+
9. Commit your changes
4249

4350
```bash
4451
git commit -m 'Add AmazingFeature'
4552
```
4653

47-
9. Push to the branch
54+
10. Push to the branch
4855

4956
```bash
5057
git push origin feature/AmazingFeature
5158
```
5259

53-
10. Open a Pull Request
60+
11. Open a Pull Request
61+
62+
**Note:** Please ensure your code adheres to our style guidelines and includes appropriate documentation for any new features.

‎README.md‎

Lines changed: 34 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,48 @@
11
<div style="text-align: center">
2-
<img src="mlflow-site/public/assets/MLflow-js-logo.png" width="500px;"/></div>
3-
4-
<br>
5-
6-
<div style="text-align: center">
7-
8-
<!-- [![TypeScript](https://img.shields.io/badge/-TypeScript-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
9-
[![JavaScript](https://img.shields.io/badge/-JavaScript-000435?style=flat-square&logo=javascript&logoColor=00fff)](https://www.javascript.com/)
10-
[![Next.js](https://img.shields.io/badge/-Next.js-24292e?style=flat-square&logo=next.js&logoColor=00fff)](https://nextjs.org/)
11-
[![TailwindCSS](https://img.shields.io/badge/-Tailwind_CSS-008080?style=flat-square&logo=tailwindcss&logoColor=bfffff)](https://tailwindcss.com/)
12-
[![Node.js](https://img.shields.io/badge/-Node.js-339933?style=flat-square&logo=node.js&logoColor=ffffff)](https://nodejs.org/en/)
13-
[![Jest](https://img.shields.io/badge/-Jest-800020?style=flat-square&logo=jest&logoColor=00fff)](https://jestjs.io/)
14-
[![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-30363d?style=flat-square&logo=GitHub&logoColor=00fff)](https://github.com/features/actions)
15-
[![NPM](https://img.shields.io/badge/-NPM-CC3534?style=flat-square&logo=npm&logoColor=00fff)](https://www.npmjs.com/)
16-
[![Vercel](https://img.shields.io/badge/-Vercel-966FD6?style=flat-square&logo=vercel&logoColor=black)](https://vercel.com/) -->
17-
18-
</div>
2+
<img src="mlflow-site/public/assets/mlflow-js-logo-whitebg.png" width=600px;"/></div>
193

204
<br>
215

226
## About
237

248
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)
259
![Release](https://img.shields.io/badge/Release-v1.0.0-426B20)
26-
![Build](https://img.shields.io/badge/Build-Passing-3bb143.svg)
27-
![Static Badge](https://img.shields.io/badge/Coverage-80%-c7ea46.svg)
28-
[![Contributions](https://img.shields.io/badge/Contributions-Welcome-3bb143.svg)](/CONTRIBUTING.md)
10+
![Build](https://img.shields.io/badge/Build-Passing-brightgreen.svg)
11+
![Coverage](https://img.shields.io/badge/Coverage-80%25-c7ea46.svg)
12+
[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](/CONTRIBUTING.md)
2913

3014
<i>mlflow.js</i> is an open-source npm library designed for JavaScript developers who want to integrate with MLflow, providing tools and functionalities for managing machine learning lifecycle.
3115

32-
<a href="">Check out the mlflow.js official site here!</a>
33-
34-
<!-- ![Build Status](https://cdn.prod.website-files.com/5e0f1144930a8bc8aace526c/65dd9eb5aaca434fac4f1c7c_Build-Passing-brightgreen.svg) -->
16+
<a href="">Visit the official mlflow.js site for more info!</a>
3517

36-
Vist our LinkedIn page here:
18+
Visit our LinkedIn page below:
3719

3820
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/mlflowjs/)
3921

4022
<br>
4123

4224
## Features
4325

44-
<i>mlflow.js</i> covers all REST API endpoints under MLFlow's Tracking Server and Model Registry. Moreover, high-level abstraction workflows are developed in hope to facilitate developers' work process.
26+
<i>mlflow.js</i> covers all REST API endpoints under MLflow's Tracking Server and Model Registry. Official documentation for MLflow.js can be found <a href="">here</a>. Moreover, high-level abstraction workflows have been developed to facilitate developers' work processes.
27+
28+
### High-Level Abstraction Workflows
29+
30+
**Experiment Manager**
31+
32+
- runExistingExperiment - Full workflow of creating, naming, and starting a run under an existing experiment, logging metrics, params, tags, and the model, and finishing the run
33+
- runNewExperiment - Full workflow of creating, naming, and starting a run under a new experiment, ogging mettrics, params,tags, and the model, and finishing the run
34+
- experimentSummary - Returns an array of all the passed-in experiment's runs, sorted accoroding to the passed-in metric
35+
36+
**Run Manager**
37+
38+
- cleanupRuns - Deletes runs that do not meet certain criteria and return an object of deleted runs and details
39+
- copyRun - Copies a run from one experiment to another (without artifacts and models)
40+
41+
**Model Manager**
42+
43+
- createRegisteredModelWithVersion - Creates a new registered model and the frist version of that model
44+
- updateRegisteredModelDescriptionAndTag - Updates a registered model's description and tags
45+
- updateAllLatestModelVersion - Updates the latest version of the specified registered model's description, adds a new alias, and tag key/value foro tthat latest version
4546

4647
<br>
4748

@@ -72,7 +73,7 @@ Ensure MLflow is installed on your system:
7273
pip install mlflow
7374
```
7475

75-
Note: MLflow is compatible with MacOS. If you encoutner 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`.
76+
Note: MLflow is compatible with MacOS. If you encountner 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`.
7677

7778
### Start the MLflow Tracking Server
7879

@@ -144,23 +145,10 @@ We welcome contributions to mlflow.js! Please see our [Contributing Guide](CONTR
144145

145146
## Meet The Team
146147

147-
| [<img src="mlflow-site/public/assets/kylerpfp.png" width="100px;"/></a>](https://github.com/Kyler-Chiago) | [<img src="https://github.com/austinbfraser.png" width="100px;"/></a>](https://github.com/austinbfraser) | [<img src="https://github.com/seneyu.png" width="100px;"/></a>](https://github.com/seneyu) | [<img src="https://github.com/winjolu.png" width="100px;"/></a>](https://github.com/winjolu) | [<img src="https://github.com/yiqunzheng.png" width="100px;"/></a>](https://github.com/yiqunzheng) |
148-
| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
149-
| Kyler Chiago <br> [GitHub](https://github.com/Kyler-Chiago) <br> [LinkedIn](https://www.linkedin.com/in/kyler-chiago/) | Austin Fraser <br> [GitHub](https://github.com/austinbfraser) <br> [LinkedIn](http://www.linkedin.com/in/austin-fraser) | Stephany Ho <br> [GitHub](https://github.com/seneyu) <br> [LinkedIn](https://www.linkedin.com/in/stephanyho/) | Winston Ludlam <br> [GitHub](https://github.com/winjolu/) <br> [LinkedIn](https://www.linkedin.com/in/wjludlam/) | Yiqun Zheng <br> [GitHub](https://github.com/yiqunzheng) <br> [LinkedIn](https://www.linkedin.com/in/yiqunzheng/) |
150-
151-
OR
152-
153-
- Kyler Chiago [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/Kyler-Chiago)
154-
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kyler-chiago/)
155-
156-
- Austin Fraser [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/austinbfraser)
157-
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](http://www.linkedin.com/in/austin-fraser)
158-
159-
- Stephany Ho [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/seneyu)
160-
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/stephanyho/)
161-
162-
- Winston Ludlam [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/winjolu/)
163-
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/wjludlam/)
164-
165-
- Yiqun Zheng [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/yiqunzheng)
166-
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/yiqunzheng/)
148+
| Name | GitHub | LinkedIn |
149+
| -------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
150+
| Kyler Chiago | [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/Kyler-Chiago) | [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kyler-chiago/) |
151+
| Austin Fraser | [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/austinbfraser) | [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](http://www.linkedin.com/in/austin-fraser) |
152+
| Stephany Ho | [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/seneyu) | [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/stephanyho/) |
153+
| Winston Ludlam | [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/winjolu/) | [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/wjludlam/) |
154+
| Yiqun Zheng | [![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github)](https://github.com/yiqunzheng) | [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/yiqunzheng/) |

‎mlflow-site/public/assets/mlflow-js-logo-whitebg.png‎

47 KB
Loading

0 commit comments

Comments
 (0)