Update README.md
Browse files
README.md
CHANGED
|
@@ -76,39 +76,47 @@ Example Applications
|
|
| 76 |
- Creative writing prompts
|
| 77 |
- Interactive fiction development
|
| 78 |
|
| 79 |
-
Usage Example
|
|
|
|
| 80 |
from datasets import load_dataset
|
|
|
|
| 81 |
|
| 82 |
-
|
|
|
|
| 83 |
dataset = load_dataset("Idrinth/gamemasterai")
|
|
|
|
| 84 |
|
| 85 |
-
|
|
|
|
| 86 |
train_data = dataset["train"]
|
| 87 |
print(f"Number of examples: {len(train_data)}")
|
|
|
|
| 88 |
|
| 89 |
-
|
|
|
|
| 90 |
sample = train_data[0]
|
| 91 |
print("Sample conversation:")
|
| 92 |
for message in sample["messages"]:
|
| 93 |
print(f"{message['role']}: {message['content']}")
|
|
|
|
| 94 |
|
| 95 |
-
Limitations and Considerations
|
| 96 |
- Small dataset size: Currently only 5 training examples, limiting models's exposure to
|
| 97 |
diverse scenarios
|
| 98 |
- Domain-specific: Focused specifically on RPG/fantasy scenarios
|
| 99 |
- English only: No multilingual support
|
| 100 |
- Early stage: Dataset is actively being expanded with more training scenarios
|
| 101 |
|
| 102 |
-
Contributing
|
| 103 |
The dataset is actively being expanded. Contributors can help by:
|
| 104 |
- Adding new RPG scenario examples
|
| 105 |
- Improving existing conversatin quality
|
| 106 |
- Suggesting additional use cases
|
| 107 |
|
| 108 |
-
For contributions, visit the [GitHub Repository](https://github.com/bjoern-buettner/roleplay-ai) or join the Discord community.
|
| 109 |
|
| 110 |
-
Citation
|
| 111 |
-
If you use this dataset in your research or applications, please cite
|
| 112 |
@dataset{gamemaster_ai,
|
| 113 |
title={Gamemaster AI Training Dataset},
|
| 114 |
author={Björn Büttner},
|
|
|
|
| 76 |
- Creative writing prompts
|
| 77 |
- Interactive fiction development
|
| 78 |
|
| 79 |
+
## Usage Example
|
| 80 |
+
```py
|
| 81 |
from datasets import load_dataset
|
| 82 |
+
```
|
| 83 |
|
| 84 |
+
### Load the dataset
|
| 85 |
+
```py
|
| 86 |
dataset = load_dataset("Idrinth/gamemasterai")
|
| 87 |
+
```
|
| 88 |
|
| 89 |
+
#### Access training examples
|
| 90 |
+
```py
|
| 91 |
train_data = dataset["train"]
|
| 92 |
print(f"Number of examples: {len(train_data)}")
|
| 93 |
+
```
|
| 94 |
|
| 95 |
+
### View a sample conversation
|
| 96 |
+
```py
|
| 97 |
sample = train_data[0]
|
| 98 |
print("Sample conversation:")
|
| 99 |
for message in sample["messages"]:
|
| 100 |
print(f"{message['role']}: {message['content']}")
|
| 101 |
+
```
|
| 102 |
|
| 103 |
+
## Limitations and Considerations
|
| 104 |
- Small dataset size: Currently only 5 training examples, limiting models's exposure to
|
| 105 |
diverse scenarios
|
| 106 |
- Domain-specific: Focused specifically on RPG/fantasy scenarios
|
| 107 |
- English only: No multilingual support
|
| 108 |
- Early stage: Dataset is actively being expanded with more training scenarios
|
| 109 |
|
| 110 |
+
## Contributing
|
| 111 |
The dataset is actively being expanded. Contributors can help by:
|
| 112 |
- Adding new RPG scenario examples
|
| 113 |
- Improving existing conversatin quality
|
| 114 |
- Suggesting additional use cases
|
| 115 |
|
| 116 |
+
For contributions, visit the [GitHub Repository](https://github.com/bjoern-buettner/roleplay-ai) or join the [Discord community](https://discord.gg/idrinth).
|
| 117 |
|
| 118 |
+
## Citation
|
| 119 |
+
If you use this dataset in your research or applications, please cite
|
| 120 |
@dataset{gamemaster_ai,
|
| 121 |
title={Gamemaster AI Training Dataset},
|
| 122 |
author={Björn Büttner},
|