Update README.md
Browse files
README.md
CHANGED
|
@@ -1,13 +1,32 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
|
| 5 |
-
|
| 6 |
|
| 7 |
-
This repo contains useful snippets for discussions.
|
| 8 |
This dataset is gated at July 2024.
|
| 9 |
|
| 10 |
-
|
| 11 |
|
| 12 |
```
|
| 13 |
# Topic
|
|
@@ -25,13 +44,6 @@ Subcategory: ___
|
|
| 25 |
...
|
| 26 |
```
|
| 27 |
|
| 28 |
-
## Usage
|
| 29 |
-
|
| 30 |
-
We refer you to [ORAssistant](https://github.com/The-OpenROAD-Project/ORAssistant), the OpenROAD chatbot
|
| 31 |
-
application aimed to answer user queries for installation and common
|
| 32 |
-
issues. This dataset is used as a data source for the chatbot's retrieval
|
| 33 |
-
augmented generation (RAG) architecture.
|
| 34 |
-
|
| 35 |
## Citing this Work
|
| 36 |
|
| 37 |
If you use this software in any published work, we would appreciate a citation!
|
|
@@ -40,9 +52,9 @@ Please use the following reference:
|
|
| 40 |
```
|
| 41 |
@misc{orassistant2024,
|
| 42 |
author = {The-OpenROAD-Project},
|
| 43 |
-
title = {
|
| 44 |
year = {2024},
|
| 45 |
-
url = {https://huggingface.co/datasets/The-OpenROAD-Project/
|
| 46 |
note = {Accessed: 20xx-xx-xx}
|
| 47 |
}
|
| 48 |
```
|
|
@@ -50,3 +62,7 @@ Please use the following reference:
|
|
| 50 |
## License
|
| 51 |
|
| 52 |
The repository has a GPL3 license.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ORAssistant RAG Dataset
|
| 2 |
+
|
| 3 |
+
This repo contains the RAG datasets used for our chatbot application.
|
| 4 |
+
This dataset is gated at July 2024.
|
| 5 |
+
|
| 6 |
+
## Contents
|
| 7 |
+
|
| 8 |
+
- [x] OpenROAD Manpages
|
| 9 |
+
- [x] OpenROAD [Docs](https://openroad.readthedocs.io/en/latest/)
|
| 10 |
+
- [x] OpenROAD-flow-scripts [Docs](https://openroad-flow-scripts.readthedocs.io/en/latest/index2.html)
|
| 11 |
+
- [x] OpenROAD issues
|
| 12 |
+
- [x] OpenROAD discussions
|
| 13 |
+
- [x] OpenROAD publications
|
| 14 |
+
- [x] KLayout
|
| 15 |
+
- [x] OpenSTA
|
| 16 |
+
- [x] Yosys
|
| 17 |
+
|
| 18 |
+
## Usage
|
| 19 |
+
|
| 20 |
+
We refer you to [ORAssistant](https://github.com/The-OpenROAD-Project/ORAssistant), the OpenROAD chatbot
|
| 21 |
+
application aimed to answer user queries for installation and common
|
| 22 |
+
issues. This dataset is used as a data source for the chatbot's retrieval
|
| 23 |
+
augmented generation (RAG) architecture.
|
| 24 |
|
| 25 |
+
## OpenROAD GitHub Discussion Dataset
|
| 26 |
|
|
|
|
| 27 |
This dataset is gated at July 2024.
|
| 28 |
|
| 29 |
+
### Format
|
| 30 |
|
| 31 |
```
|
| 32 |
# Topic
|
|
|
|
| 44 |
...
|
| 45 |
```
|
| 46 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 47 |
## Citing this Work
|
| 48 |
|
| 49 |
If you use this software in any published work, we would appreciate a citation!
|
|
|
|
| 52 |
```
|
| 53 |
@misc{orassistant2024,
|
| 54 |
author = {The-OpenROAD-Project},
|
| 55 |
+
title = {ORAssistant RAG Dataset Huggingface Repository},
|
| 56 |
year = {2024},
|
| 57 |
+
url = {https://huggingface.co/datasets/The-OpenROAD-Project/ORAssistant_RAG_Dataset},
|
| 58 |
note = {Accessed: 20xx-xx-xx}
|
| 59 |
}
|
| 60 |
```
|
|
|
|
| 62 |
## License
|
| 63 |
|
| 64 |
The repository has a GPL3 license.
|
| 65 |
+
|
| 66 |
+
---
|
| 67 |
+
license: gpl-3.0
|
| 68 |
+
---
|