Skip to content

Commit

Permalink
Update README (Xiang) (All-Hands-AI#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
xiangyue9607 authored Mar 17, 2024
1 parent 39add27 commit 3b73809
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 3 deletions.
Binary file added OpenDevinLogo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 52 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,55 @@
# OpenDevin
<p align="center">
<img alt="OpenDevin Logo" src="./OpenDevinLogo.jpg" width="100" />
</p>

# OpenDevin: Code Less, Make More

![License](https://img.shields.io/badge/license-MIT-green)

## Mission 🎯
Devin is an autonomous agent πŸ€– that tackles software engineering tasks through the use of its shell, code editor, and web browser. This rekindles the immense potential of LLMs in the software engineering domain, offering a new beacon of hope. This project aspires to replicate, enhance, and innovate upon Devin through the power of the open-source community.
Welcome to OpenDevin, an open-source project aiming to replicate [Devin](https://www.cognition-labs.com/introducing-devin), an autonomous AI software engineer who is capable of executing complex engineering tasks and collaborating actively with users on software development projects. This project aspires to replicate, enhance, and innovate upon Devin through the power of the open-source community.


## πŸ€” What is [Devin](https://www.cognition-labs.com/introducing-devin)?

Devin represents a cutting-edge autonomous agent designed to navigate the complexities of software engineering. It leverages a combination of tools such as a shell, code editor, and web browser, showcasing the untapped potential of LLMs in software development. Our goal is to explore and expand upon Devin's capabilities, identifying both its strengths and areas for improvement, to guide the progress of open code models.

## 🐚 Why OpenDevin?

The OpenDevin project is born out of a desire to replicate, enhance, and innovate beyond the original Devin model. By engaging the open-source community, we aim to tackle the challenges faced by Code LLMs in practical scenarios, producing works that significantly contribute to the community and pave the way for future advancements.

## ⭐️ Initial Steps

Achieving full replication of production-grade applications with LLMs is a complex endeavor. Our strategy involves:

1. **Core Technical Research:** Focusing on foundational research to understand and improve the technical aspects of code generation and handling.
2. **Specialist Abilities:** Enhancing the effectiveness of core components through data curation, training methods, and more.
3. **Task Planning:** Developing capabilities for bug detection, codebase management, and optimization.
4. **Evaluation:** Establishing comprehensive evaluation metrics to better understand and improve our models.


## πŸ›  Technology Stack

- **Sandboxing Environment:** Ensuring safe execution of code using technologies like Docker and Kubernetes.
- **Frontend Interface:** Developing user-friendly interfaces for monitoring progress and interacting with Devin, potentially leveraging frameworks like React or creating a VSCode plugin for a more integrated experience.

## πŸš€ Next Steps

- **Literature Review:** Conduct a thorough review of existing literature (1-2 weeks).
- **Community Engagement:** Release the plan to the community, form research groups, and begin collaborative work.

## How to Contribute

OpenDevin is a community-driven project, and we welcome contributions from everyone. Whether you're a developer, a researcher, or simply enthusiastic about advancing the field of software engineering with AI, there are many ways to get involved:

- **Code Contributions:** Help us develop the core functionalities, frontend interface, or sandboxing solutions.
- **Research and Evaluation:** Contribute to our understanding of LLMs in software engineering, participate in evaluating the models, or suggest improvements.
- **Feedback and Testing:** Use the OpenDevin toolset, report bugs, suggest features, or provide feedback on usability.

**Please fill in the [form](https://forms.gle/758d5p6Ve8r2nxxq6) if you would like to become a core member of OpenDevin Team. We will reach out shortly if we feel you are a good fit to the current team!**

## Stay Connected

Join our community to stay updated on OpenDevin's progress, share your ideas, and collaborate with fellow enthusiasts and experts. Together, we can make significant strides towards simplifying software engineering tasks and creating more efficient, powerful tools for developers everywhere.

🐚 Code Less, Make More.
🐚 **Code less, make more with OpenDevin.**

0 comments on commit 3b73809

Please sign in to comment.