Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This is a simpel proof-of-concept to get familiar with and experiment with the various parts of a RAG-setup.
This project was developed and tested as part of our experimental lane and is a made as a simpel proof-of-concept to
get familiar with and experiment with the various parts of a RAG-setup.
The example use-case is a chatbot, allowing us to interact with our Confluence IT documentation. As a fun twist,
it is named after our colleague Peter, who is a great source of knowledge and will be retiring soon.
The example use-case is a chatbot, allowing us to interact with our Confluence IT documentation in natural language. As a fun twist,
it is named after our recently retired colleague Peter, who has been a great source of knowledge.
## Key Findings & Experimentation Details
## ⚠ Warnings ⚠
This project has been created mostly in my free time and is for educational purposes only. It is not intended for production use. The code is not optimized for performance or security, nor
To learn more about our experiments and findings, please refer to our [presentation](https://intranet.wur.nl/Project/WRModellingToolbox/Documents?path=%2FWageningen%20Model%20and%20Data%20Day%2F2024&preview=SQQ39K4YAk-ThrnsD0JCXA) given during the WUR Model & Data Day.
## Collaboration Invitation
We believe that innovation thrives on collaboration. We invite LLM enthusiasts, researchers, and developers to join the LLM Focus Group.
Your insights and shared experiments are highly welcome. Feel free to contact Cristina Huidiu for more information [cristina.huidiu@wur.nl](mailto:cristina.huidiu@wur.nl).
We're currently planning multiple concrete challenges that still need to be tackled, and will be reaching out for volunteers in due time.
## Disclaimer
**Please be aware that the code in this repository is provided "as-is" without any support or guarantee.** Use it, modify it,
or improve it as you see fit, but understand that this is an experimental initiative.
## Warnings ⚠
* This project has been created mostly in my free time and is for educational purposes only. It is not intended for production use. The code is not optimized for performance or security, nor
does it have proper error handling or any test-coverage.
This project allows you to use your own data. Note that quality of input data is crucial for the quality of the final output.
*This project allows you to use your own data. Note that quality of input data is crucial for the quality of the final output.
An important todo that's still open: Implement a way to structurally assess quality and reliability of a whole RAG chain and the individual components.
*An important todo that's still open: Implement a way to structurally assess quality and reliability of a whole RAG chain and the individual components.
Please note that `allow_dangerous_deserialization` is set to true for loading an earlier created FAISS index from disk.
*Please note that `allow_dangerous_deserialization` is set to true for loading an earlier created FAISS index from disk.
## Used packages
...
...
@@ -156,3 +173,6 @@ Add a `MODEL_CONFIG_FILE=name_of_the_model_config.yaml` to the `.env` file in th
See huggingface for available models: https://huggingface.co/models?pipeline_tag=text-generation
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
