Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
@samholt
samholt committed Apr 23, 2024
1 parent 5b78fd2 commit bca70fb
Showing 1 changed file with 23 additions and 37 deletions.
60 changes: 23 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,10 @@

<p align="center">
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
<a href="docs/ROADMAP.md"><img src="https://img.shields.io/badge/ROADMAP-blue" alt="roadmap"></a>
<a href="docs/guide/roadmap.md"><img src="https://img.shields.io/badge/ROADMAP-blue" alt="roadmap"></a>
<a href="https://discord.gg/z27CxnwdhY"><img src="https://dcbadge.vercel.app/api/server/z27CxnwdhY?style=flat" alt="Discord Follow"></a>
</p>

<p align="center">
<a href="https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/samholt/l2mac"><img src="https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode" alt="Open in Dev Containers"></a>
<a href="https://codespaces.new/samholt/l2mac"><img src="https://img.shields.io/badge/Github_Codespace-Open-blue?logo=github" alt="Open in GitHub Codespaces"></a>
<!-- <a href="https://huggingface.co/spaces/samholt/l2mac" target="_blank"><img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20-Hugging%20Face-blue?color=blue&logoColor=white" /></a> -->
</p>

## News
🌟 May. 7 - 11th, 2024: We will present L2MAC at the International Conference on Learning Representations (ICLR) 2024. Come meet us at ICLR in Vienna Austria! Please reach out to me at sih31 (at) cam.ac.uk so we can meet, virtual meetings accepted as well!

Expand Down Expand Up @@ -50,23 +44,22 @@ pip install --upgrade l2mac
# or `git clone https://github.com/samholt/l2mac && cd l2mac && pip install --upgrade -e .`
```

For detailed installation guidance, please refer to [cli_install]((https://samholt.github.io/L2MAC/main/en/guide/get_started/installation.html#install-stable-version)
or [docker_install]((https://samholt.github.io/L2MAC/main/en/guide/get_started/installation.html#install-with-docker)
For detailed installation guidance, please refer to [installation](https://samholt.github.io/L2MAC/guide/get_started/installation.html#install-stable-version)

### Configuration

You can init the config of L2MAC by running the following command, or manually create `~/.L2MAC/config.yaml` file:
```bash
# Check /main/en/guide/get_started/configuration.html for more details
# Check https://samholt.github.io/L2MAC/guide/get_started/configuration.html for more details
l2mac --init-config # it will create ~/.l2mac/config.yaml, just modify it to your needs
```

You can configure `~/.l2mac/config.yaml` according to the [example](https://github.com/geekan/MetaGPT/blob/main/config/config2.example.yaml) and [doc]((https://samholt.github.io/L2MAC/main/en/guide/get_started/configuration.html):
You can configure `~/.l2mac/config.yaml` according to the [example](https://github.com/samholt/L2MAC/blob/master/config/config.yaml) and [doc](https://samholt.github.io/L2MAC/guide/get_started/configuration.html):

```yaml
llm:
api_type: "openai" # or azure / ollama / open_llm etc. Check LLMType for more options
model: "gpt-4-turbo-preview" # or gpt-3.5-turbo-1106 / gpt-4-1106-preview
api_type: "openai" # or azure etc. Check ApiType for more options
model: "gpt-4-turbo-preview" # or "gpt-4-turbo"
base_url: "https://api.openai.com/v1" # or forward url / other llm url
api_key: "YOUR_API_KEY"
```
Expand All @@ -76,62 +69,55 @@ llm:
After installation, you can use L2MAC CLI
```bash
l2mac "Create a beautiful playable python snake game with pygame" # this will create a repo in ./workspace
l2mac "Create a beautiful, playable and simple snake game with pygame. Make the snake and food be aligned to the same 10-pixel grid." # this will create a codebase repo in ./workspace
```

or use it as library
or use it as a library

```python
from l2mac import generate_codebase
codebase: dict = generate_codebase("Create a beautiful playable python snake game with pygame")
print(codebase) # it will print the codebase (repo) complete with all the files as a dictionary
codebase: dict = generate_codebase("Create a beautiful, playable and simple snake game with pygame. Make the snake and food be aligned to the same 10-pixel grid.")
print(codebase) # it will print the codebase (repo) complete with all the files as a dictionary, and produce a local codebase folder in ./workspace
```

### QuickStart & Demo Video
<!-- - Try it on [L2MAC Huggingface Space](https://huggingface.co/spaces/samholt/l2mac) -->
<!-- - [Official Demo Video](https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d) -->

<!-- https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419 -->
### [QuickStart](https://github.com/samholt/L2MAC/guide/get_started/quickstart.html)

## Tutorial

- 🗒 [Online Document](https://samholt.github.io/l2mac/)
- 💻 [Usage](https://samholt.github.io/L2MAC/main/en/guide/get_started/quickstart.html)
- 🔎 [What can MetaGPT do?](https://samholt.github.io/L2MAC/main/en/guide/get_started/introduction.html)
- 🗒 [Online Documentation](https://samholt.github.io/l2mac/)
- 💻 [Usage](https://github.com/samholt/L2MAC/guide/get_started/quickstart.html)
- 🔎 [What can L2MAC do?](https://samholt.github.io/l2mac/guide/get_started/introduction.html)
- 🖼️ [Gallery of Examples Produced](https://samholt.github.io/l2mac/guide/use_cases/gallery.html)
- 🛠 How to run L2MAC?
- [MetaGPT Usage & Development Guide | Agent 101]((https://samholt.github.io/L2MAC/main/en/guide/tutorials/agent_101.html)
- [MetaGPT Usage & Development Guide | MultiAgent 101]((https://samholt.github.io/L2MAC/main/en/guide/tutorials/multi_agent_101.html)
- [L2MAC Usage & Development Guide | L2MAC 101](https://samholt.github.io/l2mac/guide/tutorials/l2mac_101.html)
- 🧑‍💻 Contribution
- [Develop Roadmap](docs/ROADMAP.md)
- [Development Roadmap](https://samholt.github.io/l2mac/guide/roadmap.html)
- 🔖 Use Cases
- [Create a state-of-the-art large codebase]((https://samholt.github.io/L2MAC/main/en/guide/use_cases/agent/interpreter/intro.html)
- [Create an entire book]((https://samholt.github.io/L2MAC/main/en/guide/use_cases/multi_agent/debate.html)
- ❓ [FAQs]((https://samholt.github.io/L2MAC/main/en/guide/faq.html)
- [Create a state-of-the-art large codebase](https://samholt.github.io/l2mac/guide/use_cases/codebase_generator.html)
- [Create an entire book](https://samholt.github.io/l2mac/guide/use_cases/book_generator.html)
- ❓ [FAQs](https://samholt.github.io/l2mac/guide/faq.html)

## Support

### Discord Join US

📢 Join Our [Discord Channel](https://discord.gg/ZRHeExS6xv)! Looking forward to seeing you there! 🎉

### Contributor form
📢 Join Our [Discord Channel](https://discord.gg/z27CxnwdhY)! Looking forward to seeing you there! 🎉

📝 [Fill out the form](google form) to become a contributor. We are looking forward to your participation!

### Contact Information

If you have any questions or feedback about this project, please feel free to contact us. We highly appreciate your suggestions!

- **Email:** sih31 at cam.ac.uk
- **GitHub Issues:** For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/samholt/l2mac/issues).
- **GitHub Issues:** For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/samholt/L2MAC/issues).

We will respond to all questions within 2-3 business days.

## Citation

To stay updated with the latest research and development, follow [@samianholt](https://twitter.com/samianholt) on Twitter.

To cite [L2MAC](https://arxiv.org/abs/2310.02003) in publications, please use the following BibTeX entries.
To cite [L2MAC](https://openreview.net/forum?id=EhrzQwsV4K) in publications, please use the following BibTeX entry.

```bibtex
@inproceedings{
Expand Down

0 comments on commit bca70fb

Please sign in to comment.