Skip to content

Commit cadcd6a

Browse files
seneyuseneyu
committed
Some changes on readme
1 parent b5437a8 commit cadcd6a

File tree

2 files changed

+116
-13
lines changed

2 files changed

+116
-13
lines changed

‎CONTRIBUTING.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## Contributing
2+
3+
We are always open to accepting any potential contributions. Here is how you can contribute:
4+
5+
1. Fork the repository
6+
2. Clone your forked repository
7+
8+
```bash
9+
git clone https://github.com/your-username/respository-name.git
10+
```
11+
12+
3. Install dependencies for both mlflow and mlfow-site directories
13+
14+
```bash
15+
cd mlflow && npm install
16+
cd ../mlflow-site && npm install
17+
```
18+
19+
4. Run the mlflow-site
20+
21+
```bash
22+
npm run dev
23+
```
24+
25+
5. Create your feature branch
26+
27+
```bash
28+
git checkout -b feature/AmazingFeature
29+
```
30+
31+
6. Make your changes
32+
33+
7. Run tests to ensure your changes don't break existing functionality
34+
35+
(Make sure you have mlflow UI server running on port 5002: `mlflow ui --port 5002`)
36+
37+
```bash
38+
npm run test
39+
```
40+
41+
8. Commit your changes
42+
43+
```bash
44+
git commit -m 'Add AmazingFeature'
45+
```
46+
47+
9. Push to the branch
48+
49+
```bash
50+
git push origin feature/AmazingFeature
51+
```
52+
53+
10. Open a Pull Request

‎README.md‎

Lines changed: 63 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,64 @@
1-
<img src="../mlflow-js/mlflow-site/public/assets/MLflow-js-logo.png" width="500px;"/>
1+
<div style="text-align: center">
2+
<img src="mlflow-site/public/assets/MLflow-js-logo.png" width="500px;"/></div>
23

34
<br>
45

5-
[![TypeScript](https://img.shields.io/badge/-TypeScript-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
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/)
69
[![JavaScript](https://img.shields.io/badge/-JavaScript-000435?style=flat-square&logo=javascript&logoColor=00fff)](https://www.javascript.com/)
7-
[![Next.js](https://img.shields.io/badge/-Next.js-000435?style=flat-square&logo=next.js&logoColor=00fff)](https://nextjs.org/)
8-
[![TailwindCSS](https://img.shields.io/badge/-Tailwind_CSS-000435?style=flat-square&logo=tailwindcss&logoColor=00fff)](https://tailwindcss.com/)
9-
[![Jest](https://img.shields.io/badge/-Jest-800020?style=flat-square&logo=jest&logoColor=00fff)](https://jestjs.io/)
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/)
1012
[![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)
1115
[![NPM](https://img.shields.io/badge/-NPM-CC3534?style=flat-square&logo=npm&logoColor=00fff)](https://www.npmjs.com/)
12-
[![Vercel](https://img.shields.io/badge/-Vercel-966FD6?style=flat-square&logo=vercel&logoColor=black)](https://www.npmjs.com/)
16+
[![Vercel](https://img.shields.io/badge/-Vercel-966FD6?style=flat-square&logo=vercel&logoColor=black)](https://vercel.com/) -->
1317

14-
<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.
18+
</div>
1519

1620
<br>
1721

1822
## About
1923

20-
Code coverage percentage: ![Static Badge](https://img.shields.io/badge/coverage-80%25-%237e9e0f)
24+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)
25+
![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)
29+
30+
<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.
31+
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) -->
35+
36+
Vist our LinkedIn page here:
37+
38+
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/mlflowjs/)
39+
40+
<br>
41+
42+
## Features
43+
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.
45+
46+
<br>
2147

22-
Release version:
23-
![Static Badge](https://img.shields.io/badge/mlflow.js-v1.0.0-426B20?style=flat-square&label=mlflow.js&labelColor=426B20&color=282828)
48+
## Built with
49+
50+
[![TypeScript](https://img.shields.io/badge/TypeScript-0077B5?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
51+
[![JavaScript](https://img.shields.io/badge/JavaScript-000435?style=for-the-badge&logo=javascript&logoColor=00fff)](https://www.javascript.com/)
52+
[![React](https://img.shields.io/badge/React-36454F?style=for-the-badge&logo=React&logoColor=00fff)](https://react.dev/)
53+
[![Next.js](https://img.shields.io/badge/Next.js-24292e?style=for-the-badge&logo=next.js&logoColor=00fff)](https://nextjs.org/)
54+
[![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-008080?style=for-the-badge&logo=tailwindcss&logoColor=bfffff)](https://tailwindcss.com/)
55+
[![ESLINT](https://img.shields.io/badge/ESLINT-4B32C3?style=for-the-badge&logo=eslint&logoColor=bfffff)](https://eslint.org/)
56+
[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=ffffff)](https://nodejs.org/en/)
57+
[![Jest](https://img.shields.io/badge/Jest-800020?style=for-the-badge&logo=jest&logoColor=00fff)](https://jestjs.io/)
58+
[![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-30363d?style=for-the-badge&logo=github&logoColor=00fff)](https://github.com/features/actions)
59+
[![Docker](https://img.shields.io/badge/Docker-lightblue?style=for-the-badge&logo=Docker&logoColor=00fff)](https://www.docker.com/)
60+
[![NPM](https://img.shields.io/badge/NPM-CC3534?style=for-the-badge&logo=npm&logoColor=00fff)](https://www.npmjs.com/)
61+
[![Vercel](https://img.shields.io/badge/Vercel-966FD6?style=for-the-badge&logo=Vercel&logoColor=00fff)](https://vercel.com/)
2462

2563
<br>
2664

@@ -55,7 +93,7 @@ This will launch the MLflow UI on your local machine at `http://localhost:5000`.
5593
To use the MLflow.js library, navigate to your project directory and install it via npm:
5694

5795
```bash
58-
npm instatll mlflow-js
96+
npm install mlflow-js
5997
```
6098

6199
### Usage Example
@@ -88,13 +126,25 @@ createExperiment();
88126

89127
## Documentation
90128

91-
Official documentation for MLflow.js can be found at ...
129+
Official documentation for MLflow.js can be found <a href="">here</a>.
130+
131+
<br>
132+
133+
## Contributing
134+
135+
We welcome contributions to mlflow.js! Please see our [Contributing Guide](CONTRIBUTING.md) for more details on how to get started.
136+
137+
<br>
138+
139+
## License
140+
141+
[MIT](/LICENSE)
92142

93143
<br>
94144

95145
## Meet The Team
96146

97-
| [<img src="../mlflow-js/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) |
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) |
98148
| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
99149
| 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/) |
100150

0 commit comments

Comments
 (0)