Skip to content

Commit 54178e0

Browse files
committed
Merge branch 'dev' into stephany/github-actions-3
2 parents 40ee8b7 + 709e4c7 commit 54178e0

File tree

5 files changed

+39
-36
lines changed

5 files changed

+39
-36
lines changed

.github/README.md README.md

+14-11
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)
9-
![Release](https://img.shields.io/badge/Release-v1.0.0-426B20)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)
9+
![Release](https://img.shields.io/badge/Release-v1.0.1-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](/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/) |

mlflow-site/README.md

+1-22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
2-
31
## Getting Started
42

53
First, run the development server:
@@ -14,23 +12,4 @@ pnpm dev
1412
bun dev
1513
```
1614

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20-
21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
22-
23-
## Learn More
24-
25-
To learn more about Next.js, take a look at the following resources:
26-
27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29-
30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
31-
32-
## Deploy on Vercel
33-
34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
35-
36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
15+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

mlflow/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Open Source Labs Beta
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

mlflow/package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mlflow/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mlflow-js",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "JavaScript library for MLflow",
55
"homepage": "https://www.mlflow-js.org/",
66
"repository": {

0 commit comments

Comments
 (0)