-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added generation of README.md from data.yaml
- Loading branch information
Showing
6 changed files
with
392 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| *venv | ||
| .*cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <!-- | ||
|
|
||
| Hey, you! | ||
| Are you reading this in the generated README.md? Then you're in the wrong place! | ||
|
|
||
| The template and data used to generate the README is in `README.md.in` and `data.json`, respectively. | ||
|
|
||
| The README.md is generated using the following command: python3 generate_readme.py | ||
|
|
||
| --> | ||
|
|
||
| # 🛠️ Are Copilots Local Yet? | ||
|
|
||
| Current trends and state of the art for using open & local LLM models as copilots to complete code, generate projects, act as shell assistants, automatically fix bugs, and more. | ||
|
|
||
| 📝 *Help keep this list relevant and up-to-date by [making edits][edit]!* | ||
|
|
||
| [edit]: https://github.com/ErikBjare/are-copilots-local-yet/edit/master/README.md | ||
|
|
||
| ## 📋 Summary | ||
|
|
||
| Local Copilots are in an early experimental stage, with most being of MVP-quality. | ||
|
|
||
| The reasons for this are: | ||
|
|
||
| - 📉 Local models still being inferior to Copilot | ||
| - 🔧 Difficult to set up | ||
| - 💻 High hardware requirements | ||
|
|
||
| However, as models improve, and editor extensions get developed to use them, we're expected to get a renaissance of code-completion tools. | ||
|
|
||
| This document is a curated list of local Copilots, shell assistants, and related projects. It is intended to be a resource for those interested in a survey of the existing tools, and to help developers discover the state of the art for projects like these. | ||
|
|
||
| ## 📚 Background | ||
|
|
||
| In 2021, GitHub released Copilot which quickly became popular among devs. Since then, with the flurry of AI developments around LLMs, local models that can run on consumer machines have become available, and it has seemed only a matter of time before Copilot will go local. | ||
|
|
||
| Many perceived limitations of GitHub's Copilot are related to its closed and cloud-hosted nature. | ||
|
|
||
| As an alternative, local Copilots enable: | ||
|
|
||
| - 🌐 Offline & private use | ||
| - ⚡ Improved responsiveness | ||
| - 📚 Better project/context awareness | ||
| - 🎯 The ability to run models specialized for a particular language/task | ||
| - 🔒 [Constraining the LLM output](https://twitter.com/ErikBjare/status/1656731582001020928) to fit a particular format/syntax. | ||
|
|
||
| ## 🧩 Extensions | ||
|
|
||
| Editor extensions used to complete code using LLMs: | ||
|
|
||
| | Name | Editor | :star: | Released | Notes | | ||
| | ------------- | -------- | ------- | -------- | --------- | | ||
| {% for item in extensions %}| [{{ item.name }}]({{ item.link }}) | {{ item.editor | join(", ") }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} | | ||
| {% endfor %} | ||
|
|
||
| ## 🛠️ Tools | ||
|
|
||
| Tools that try to generate projects/features from specification: | ||
|
|
||
| | Name | :star: | Released | Notes | | ||
| | -------------- | ------- | --------- | ----- | | ||
| {% for item in tools %}| [{{ item.name }}]({{ item.link }}) | {{ item.stars }} | {{ item.released }} | {{ item.notes }} | | ||
| {% endfor %} | ||
|
|
||
| ## 🗨️ Chat Interfaces | ||
|
|
||
| Chat interfaces with shell/REPL/notebook access. | ||
| Similar to/inspired by ChatGPT's "Advanced Data Analysis" feature (previously "Code Interpreter"). | ||
|
|
||
| | Name | :star: | Notes | | ||
| | -------------- | ------- | --------- | | ||
| {% for item in chat %}| [{{ item.name }}]({{ item.link }}) | {{ item.stars }} | {{ item.notes }} | | ||
| {% endfor %} | ||
|
|
||
| ## 🤖 Models | ||
|
|
||
| Models relevant for local Copilot-use. Ordered by most recent first. | ||
|
|
||
| | Name | Size | Languages | :star: | Released | Notes | | ||
| | ------------------------------- | ---------- | ----------- | ------- | ---------- | ------- | | ||
| {% for item in models %}| [{{ item.name }}]({{ item.link }}) | {{ item.size }} | {{ item.languages | join(", ") }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} | | ||
| {% endfor %} | ||
|
|
||
| **Note:** due to the pace of new model releases, this section is doomed to be out of date. | ||
|
|
||
| ## 📚 Datasets | ||
|
|
||
| Datasets relevant for training models. | ||
|
|
||
| | Name | Size | Languages | :star: | Released | Notes | | ||
| | ------------------------------- | ---------- | ----------- | ------- | ---------- | ------- | | ||
| {% for item in datasets %}| [{{ item.name }}]({{ item.link }}) | {{ item.size }} | {{ item.languages | join(", ") }} | {{ item.stars }} | {{ item.released }} | {{ item.notes }} | | ||
| {% endfor %} | ||
|
|
||
| ## Tools | ||
|
|
||
| Misc relevant useful tools. | ||
|
|
||
| | Name | :star: | Released | Notes | | ||
| | ------------------------------- | ------- | ---------- | ------- | | ||
| {% for item in misc %}| [{{ item.name }}]({{ item.link }}) | {{ item.stars }} | {{ item.released }} | {{ item.notes }} | | ||
| {% endfor %} | ||
|
|
||
| ## 📰 Misc | ||
|
|
||
| - 🐦 [Tweet announcing this repo][announce] | ||
|
|
||
| [announce]: https://twitter.com/ErikBjare/status/1681616666600394753 | ||
|
|
||
| ## 📈 Stats | ||
|
|
||
| Stargazers over time: | ||
|
|
||
| [](https://starchart.cc/ErikBjare/are-copilots-local-yet) |
Oops, something went wrong.