You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
1 year ago | |
---|---|---|
.github | 1 year ago | |
talk_codebase | 1 year ago | |
.gitignore | 1 year ago | |
README.md | 1 year ago | |
poetry.lock | 1 year ago | |
pyproject.toml | 1 year ago | |
requirements.txt | 1 year ago |
README.md
talk-codebase
- Talk-codebase is a tool that allows you to converse with your codebase using LLMs (Large Language Models) to answer your queries.
- It supports offline code processing using GPT4All without sharing your code with third parties, or you can use OpenAI if privacy is not a concern for you.
- Talk-codebase is still under development, but it is a tool that can help you to improve your code. It is only recommended for educational purposes and not for production use.
Installation
To install talk-codebase, you need to have:
# Install talk-codebase
pip install talk-codebase
# Configure talk-codebase
talk-codebase configure
# If you want some files to be ignored, add them to .gitignore.
# Once `talk-codebase` is installed, you can use it to chat with your codebase in the current directory by running the following command:
talk-codebase chat .
Advanced configuration
You can also edit the configuration manually by editing the ~/.config.yaml
file.
If for some reason you cannot find the configuration file, just run the tool and at the very beginning it will output
the path to the configuration file.
# The OpenAI API key. You can get it from https://beta.openai.com/account/api-keys
api_key: sk-xxx
# Configuration for chunking
chunk_overlap: 50
chunk_size: 500
# Configuration for sampling
k: 4
max_tokens: 1048
# Configuration for the LLM model
model_name: gpt-3.5-turbo
model_path: models/ggml-gpt4all-j-v1.3-groovy.bin
model_type: openai
Supports the following extensions:
.csv
.doc
.docx
.epub
.md
.pdf
.txt
popular programming languages
Contributing
- If you find a bug in talk-codebase, please report it on the project's issue tracker. When reporting a bug, please include as much information as possible, such as the steps to reproduce the bug, the expected behavior, and the actual behavior.
- If you have an idea for a new feature for Talk-codebase, please open an issue on the project's issue tracker. When suggesting a feature, please include a brief description of the feature, as well as any rationale for why the feature would be useful.
- You can contribute to talk-codebase by writing code. The project is always looking for help with improving the codebase, adding new features, and fixing bugs.