This repository is an experimental work to create a chatbot that can be trained on package documentations. The aim is to create tailored solutions for convoluted or complex documentations, making it easier for users to understand and implement the package functionalities.
.
├── README.md # This documentation
├── data # Data files, likely training data for the chatbot
├── notebooks # Jupyter notebooks, potentially for exploratory analysis or model prototyping
├── poetry.lock # Lock file for poetry dependencies, ensuring consistent package versions
├── pyproject.toml # Poetry configuration file, listing package dependencies and metadata
├── src # Source code for the chatbot application
│ └── __init__.py
└── tests # Unit and integration tests
└── __init__.py
- Python >= 3.7
- Poetry for dependency management
- Clone this repository:
git clone https://github.com/llctrautmann/DocGPT.git
cd DocGPT- Install the required dependencies using Poetry:
poetry installAdditional information on how to use the chatbot, train on new data, or integrate with other applications should be added here as the project progresses.
The main application code can be found under the src directory.
Unit tests are placed under the tests directory. To run all tests, execute:
For any exploratory data analysis, model prototyping, or other experiments, use the provided Jupyter notebooks found in the notebooks directory.
We welcome contributions! Please read our CONTRIBUTING.md guide for details on how to submit patches and the contribution workflow.
MIT