https://github.com/sitamgithub-msit/dolphin-llamacpp
Dolphin 3.0 🐬: Versatile AI for coding, math, and more
https://github.com/sitamgithub-msit/dolphin-llamacpp
chatml gguf gradio gradio-interface huggingface-hub huggingface-spaces llama3 llamacpp llamacpp-python python
Last synced: 2 months ago
JSON representation
Dolphin 3.0 🐬: Versatile AI for coding, math, and more
- Host: GitHub
- URL: https://github.com/sitamgithub-msit/dolphin-llamacpp
- Owner: sitamgithub-MSIT
- License: mit
- Created: 2025-01-14T22:51:05.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T17:29:17.000Z (3 months ago)
- Last Synced: 2025-03-12T18:33:59.212Z (3 months ago)
- Topics: chatml, gguf, gradio, gradio-interface, huggingface-hub, huggingface-spaces, llama3, llamacpp, llamacpp-python, python
- Language: Python
- Homepage: https://sitammeur-dolphin-llamacpp.hf.space
- Size: 194 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dolphin🐬 Llama.cpp
Dolphin 3.0 is a powerful, general-purpose local AI model designed for coding, math, and various other tasks, aiming similar to models like ChatGPT and Claude.
## Project Structure
The project is structured as follows:
- `app.py`: The file containing the main gradio application.
- `logger.py`: The file containing the code for logging the application.
- `exception.py`: The file containing the code for custom exceptions used in the project.
- `requirements.txt`: The file containing the list of dependencies for the project.
- `LICENSE`: The license file for the project.
- `README.md`: The README file that contains information about the project.
- `assets`: The folder containing screenshots for working on the application.
- `.gitignore`: The file containing the list of files and directories to be ignored by Git.
## Tech Stack
- Python (for the programming language)
- Llama.cpp (llama-cpp-python as Python binding for llama.cpp)
- Hugging Face Hub (for the GGUF model)
- Gradio (for the main application)
## Getting Started
To get started with this project, follow the steps below:
1. Clone the repository: `git clone https://github.com/sitamgithub-MSIT/Dolphin-llamacpp.git`
2. Change the directory: `cd Dolphin-llamacpp`
3. Create a virtual environment: `python -m venv tutorial-env`
4. Activate the virtual environment: `tutorial-env\Scripts\activate`
5. Install the required dependencies: `pip install -r requirements.txt`
6. Run the Gradio application: `python app.py`
Now, you can open up your local host and see the web application running. For more information, please refer to the Gradio documentation [here](https://www.gradio.app/docs/interface). Also, a live version of the application can be found [here](https://huggingface.co/spaces/sitammeur/Dolphin-llamacpp).
## Contributing
Contributions are welcome! If you would like to contribute to this project, please raise an issue to discuss the changes you want to make. Once the changes are approved, you can create a pull request.
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
If you have any questions or suggestions about the project, please contact me on my GitHub profile.
Happy coding! 🚀