Skip to content

Commit 2fce1b1

Browse files
committed
Changes for npm
1 parent 202cd68 commit 2fce1b1

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

.github/README.md renamed to README.md

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

44
<br>
55

66
## About
77

8-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](../LICENSE)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](/mlflow/LICENSE)
99
![Release](https://img.shields.io/badge/Release-v1.0.0-426B20)
1010
![Build](https://img.shields.io/badge/Build-Passing-brightgreen.svg)
1111
![Coverage](https://img.shields.io/badge/Coverage-87%25-c7ea46.svg)
12-
[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](../CONTRIBUTING.md)
12+
[![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.
1515

1616
<br>
1717

1818
## Features
1919

20-
<i>MLflow.js</i> covers all REST API endpoints under MLflow's Tracking Server and Model Registry. Moreover, high-level abstractions have been developed to facilitate developers' common ML workflows. It provides some key advantages:
20+
<i>MLflow.js</i> covers all REST API endpoints under MLflow's Tracking Server and Model Registry. Moreover, high-level abstractions have been developed to facilitate developers' common ML workflows. It provides some key advantages:
2121

2222
- Native JavaScript Integration: Seamlessly integrate MLflow capabilities within JavaScript codebases
2323
- Type Safety: Built with TypeScript for enhanced developer experience and code reliability
@@ -66,7 +66,8 @@ mlflow ui --port 5000
6666
This will launch the MLflow UI on your local machine at `http://localhost:5000`.
6767

6868
### Development Setup
69-
For development environment setup instructions, please refer to our [Contributing Guide](../CONTRIBUTING.md).
69+
70+
For development environment setup instructions, please refer to our [Contributing Guide](/CONTRIBUTING.md).
7071

7172
<br>
7273

@@ -99,12 +100,14 @@ async function createExperiment(){
99100
createExperiment();
100101

101102
```
103+
102104
<br>
103105

104106
## Resources
105-
- [Example Repository](https://github.com/oslabs-beta/mlflow-js/tree/dev/mlflow/examples) - Practical examples demonstrating MLflow.js’s functionality
107+
108+
- [Example Repository](https://github.com/oslabs-beta/mlflow-js/tree/dev/mlflow/examples) - Practical examples demonstrating <i>MLflow.js</i>'s functionality
106109
- [Quick Tutorials](https://www.mlflow-js.org/) - Video walkthrough of the example code with MLflow UI
107-
- [Read our Medium Article](link) - Overview on why we built MLflow.js and how it enhances ML workflows in JavaScript environments
110+
- [Read our Medium Article](link) - Overview on why we built <i>MLflow.js</i> and how it enhances ML workflows in JavaScript environments
108111

109112
<br>
110113

@@ -141,13 +144,13 @@ Official documentation for <i>MLflow.js</i> can be found <a href="https://www.ml
141144

142145
## Contributing
143146

144-
We welcome contributions to <i>MLflow.js</i>! Please see our [Contributing Guide](../CONTRIBUTING.md) for more details on how to get started.
147+
We welcome contributions to <i>MLflow.js</i>! Please see our [Contributing Guide](/CONTRIBUTING.md) for more details on how to get started.
145148

146149
<br>
147150

148151
## License
149152

150-
[MIT License](../LICENSE)
153+
[MIT License](/mlflow/LICENSE)
151154

152155
<br>
153156

@@ -159,4 +162,4 @@ We welcome contributions to <i>MLflow.js</i>! Please see our [Contributing Guide
159162
| Kyler Chiago | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github)](https://github.com/Kyler-Chiago) | [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kyler-chiago/) |
160163
| Austin Fraser | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github)](https://github.com/austinbfraser) | [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](http://www.linkedin.com/in/austin-fraser) |
161164
| Stephany Ho | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github)](https://github.com/seneyu) | [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/stephanyho/) |
162-
| Winston Ludlam | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github)](https://github.com/winjolu/) | [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/wjludlam/) |
165+
| Winston Ludlam | [![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github)](https://github.com/winjolu/) | [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/wjludlam/) |

LICENSE renamed to mlflow/LICENSE

File renamed without changes.

0 commit comments

Comments
 (0)