diff --git a/README.md b/README.md index 57bf429..a727ffe 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,53 @@ -# Technical-University-Intelligent-System +# Technical University Intelligent System -TU AI \ No newline at end of file + +## Add files + +- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files +- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: + +``` +cd existing_repo +git remote add origin https://git.bidonov.xyz/tuis/technical-university-intelligent-system.git +git branch -M main +git push -uf origin main +``` + +## Collaborate things done so far +- [x] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) +- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) +- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) +- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) + +## Description +Finetuned LLM specifically made for TU Sofia + +## Installation +Coming soon + +## Usage +Coming soon + +## Support +It works on my PC lol - you can contact me over at tarkan@horsefucker.org or message me on matrix @tarkan:bidonov.xyz + +## Roadmap +- [x] Pick a base model for finetune +- [x] Pick and optimize the inference framework +- [x] Pick and optimize the finetuning framework +- [x] Test and iron out the qurks in the frameworks +- [x] Making a finetune as proof of concept that everything works and it is optimal +- [x] Testing the model with both the local inference and API inference +- [ ] Making the dataset +- [ ] Making the eval dataset +- [ ] Running training steps for QLoRA, LoRA and Full-Finetune +- [ ] Deploying and final touches + +## Authors and acknowledgment +- Lead Developer - [Asen Velchov](https://git.bidonov.xyz/root) +- Developer and Data Architect/Engineer - [Stefan Vasilev](https://git.bidonov.xyz/chefo) +## License +This Project Uses the [MIT](https://git.bidonov.xyz/TUIS/Technical-University-Intelligent-System/src/branch/main/LICENSE) License + +## Project status +The project is in active development \ No newline at end of file