Update README.md
Browse files
README.md
CHANGED
|
@@ -1,15 +1,40 @@
|
|
| 1 |
---
|
| 2 |
license: cc-by-4.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
| 4 |
|
| 5 |
# Primock-57
|
| 6 |
|
| 7 |
This is a version of the [Primock-57](https://github.com/babylonhealth/primock57) dataset converted to the [`sdialog`](https://github.com/idiap/sdialog) `Dialog` JSON format.
|
| 8 |
-
It allows easy loading as dialog objects via `Dialog.from_file()`.
|
| 9 |
|
| 10 |
-
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
```python
|
| 15 |
from huggingface_hub import snapshot_download
|
|
@@ -21,7 +46,7 @@ snapshot_download(
|
|
| 21 |
)
|
| 22 |
```
|
| 23 |
|
| 24 |
-
Then, load the dataset as `Dialog` objects:
|
| 25 |
|
| 26 |
```python
|
| 27 |
from sdialog import Dialog
|
|
|
|
| 1 |
---
|
| 2 |
license: cc-by-4.0
|
| 3 |
+
language: en
|
| 4 |
+
pretty_name: Primock-57
|
| 5 |
+
task_categories:
|
| 6 |
+
- dialog
|
| 7 |
+
- healthcare
|
| 8 |
+
size_categories:
|
| 9 |
+
- n<100
|
| 10 |
---
|
| 11 |
|
| 12 |
# Primock-57
|
| 13 |
|
| 14 |
This is a version of the [Primock-57](https://github.com/babylonhealth/primock57) dataset converted to the [`sdialog`](https://github.com/idiap/sdialog) `Dialog` JSON format.
|
| 15 |
+
It allows easy loading as dialog objects via `Dialog.from_file()` or `Dialog.from_huggingface`.
|
| 16 |
|
| 17 |
+
The dataset contains **57** simulated primary-care style consultations (doctor ↔ patient). Each dialog is stored as an individual JSON file and includes a sequence of turns labelled by speaker.
|
| 18 |
|
| 19 |
+
---
|
| 20 |
+
## How to use (Automatically, using `Dialog.from_huggingface()`)
|
| 21 |
+
|
| 22 |
+
Simply use the [`Dialog.from_huggingface()`](https://sdialog.readthedocs.io/en/latest/api/sdialog.html#sdialog.Dialog.from_huggingface) as in the following example:
|
| 23 |
+
|
| 24 |
+
```python
|
| 25 |
+
from sdialog import Dialog
|
| 26 |
+
|
| 27 |
+
primock57_dialogs = Dialog.from_huggingface("sdialog/Primock-57")
|
| 28 |
+
|
| 29 |
+
print("Number of dialogs:", len(primock57_dialogs))
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
---
|
| 33 |
+
## How to use (Manually, using `Dialog.from_file()`)
|
| 34 |
+
|
| 35 |
+
Alternatively, if you want to do it manually, you have to:
|
| 36 |
+
|
| 37 |
+
1. First, download the dataset from the Hugging Face Hub to a local directory (e.g., `"Primock-57"`):
|
| 38 |
|
| 39 |
```python
|
| 40 |
from huggingface_hub import snapshot_download
|
|
|
|
| 46 |
)
|
| 47 |
```
|
| 48 |
|
| 49 |
+
2. Then, load the dataset as `Dialog` objects:
|
| 50 |
|
| 51 |
```python
|
| 52 |
from sdialog import Dialog
|