| # ORAssistant RAG Dataset |
|
|
| This repo contains the RAG datasets used for our chatbot application. |
| This dataset is gated at July 2024. |
|
|
| ## Contents |
|
|
| - [x] OpenROAD Manpages |
| - [x] OpenROAD [Docs](https://openroad.readthedocs.io/en/latest/) |
| - [x] OpenROAD-flow-scripts [Docs](https://openroad-flow-scripts.readthedocs.io/en/latest/index2.html) |
| - [x] OpenROAD issues |
| - [x] OpenROAD discussions |
| - [x] OpenROAD publications |
| - [x] KLayout |
| - [x] OpenSTA |
| - [x] Yosys |
|
|
| ## Usage |
|
|
| We refer you to [ORAssistant](https://github.com/The-OpenROAD-Project/ORAssistant), the OpenROAD chatbot |
| application aimed to answer user queries for installation and common |
| issues. This dataset is used as a data source for the chatbot's retrieval |
| augmented generation (RAG) architecture. |
|
|
| ## OpenROAD GitHub Discussion Dataset |
|
|
| This dataset is gated at July 2024. |
|
|
| ### Format |
|
|
| ``` |
| # Topic |
| |
| Tool: ___ |
| |
| Subcategory: ___ |
| |
| ## Conversation |
| |
| ### User1 |
| ... |
| |
| ### User2 |
| ... |
| ``` |
|
|
| ## Citing this Work |
|
|
| If you use this software in any published work, we would appreciate a citation! |
| Please use the following reference: |
|
|
| ``` |
| @misc{orassistant2024, |
| author = {The-OpenROAD-Project}, |
| title = {ORAssistant RAG Dataset Huggingface Repository}, |
| year = {2024}, |
| url = {https://huggingface.co/datasets/The-OpenROAD-Project/ORAssistant_RAG_Dataset}, |
| note = {Accessed: 20xx-xx-xx} |
| } |
| ``` |
|
|
| ## License |
|
|
| The repository has a GPL3 license. |
|
|
| --- |
| license: gpl-3.0 |
| --- |
