Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[MRG] update README.md with kaggle and report mode #215

Merged
merged 1 commit into from
Sep 20, 2024
Merged

[MRG] update README.md with kaggle and report mode #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ MLE-Agent is designed as a pairing LLM agent for machine learning engineers and
- 📂 File System Integration: Organizes your project structure efficiently.
- 🧰 Comprehensive Tools Integration: Includes AI/ML functions and MLOps tools for a seamless workflow.
- ☕ Interactive CLI Chat: Enhances your projects with an easy-to-use chat interface.
- 📊 Weekly Report: Automatically generates detailed summaries of your weekly works.


https://github.com/user-attachments/assets/dac7be90-c662-4d0d-8d3a-2bc4df9cffb9
Expand Down Expand Up @@ -66,6 +67,29 @@ You can also start an interactive chat in the terminal under the project directo
mle chat
```

## Use cases

### Generate Work Report

MLE agent can help you summarize your weekly report, including development progress, communication notes, and to-do lists.

```bash
cd <project name>
mle report
```

Then, you can visit http://localhost:3000/ to generate your report locally.
Alternatively, you can directly try our deployed service at https://workspace.repx.app/ to generate reports with more third-party extensions (e.g., Zoom, Google Calendar) supported.

### Start with Kaggle Competition

MLE agent can participate in Kaggle competitions and finish coding and debugging from data preparation to model training independently.

```bash
cd <project name>
mle kaggle
```

## Roadmap

The following is a list of the tasks we plan to do, welcome to propose something new!
Expand All @@ -79,7 +103,7 @@ The following is a list of the tasks we plan to do, welcome to propose something
- [x] Execute the code on the local machine/cloud, debug and fix the errors
- [x] Leverage the built-in functions to complete ML engineering tasks
- [x] Interactive chat: A human-in-the-loop mode to help improve the existing ML projects
- [ ] Kaggle mode: to finish a Kaggle task without humans
- [x] Kaggle mode: to finish a Kaggle task without humans
- [ ] Summary and reflect the whole ML/AI pipeline
- [ ] Integration with Cloud data and testing and debugging platforms
- [x] Local RAG support to make personal ML/AI coding assistant
Expand All @@ -100,8 +124,8 @@ The following is a list of the tasks we plan to do, welcome to propose something
<summary><b>:sparkling_heart: Better user experience</b></summary>

- [x] CLI Application
- [ ] Web UI
- [ ] Discord
- [x] Web UI
- [x] Discord
</details>

<details>
Expand Down
Loading