Upload docs/USAGE.md with huggingface_hub
Browse files- docs/USAGE.md +22 -0
docs/USAGE.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Usage
|
| 2 |
+
|
| 3 |
+
## Load with `datasets`
|
| 4 |
+
```python
|
| 5 |
+
from datasets import load_dataset
|
| 6 |
+
|
| 7 |
+
ds = load_dataset("Boredoom17/roman-nepali-corpus")
|
| 8 |
+
print(ds)
|
| 9 |
+
```
|
| 10 |
+
|
| 11 |
+
## Load directly with pandas
|
| 12 |
+
```python
|
| 13 |
+
import pandas as pd
|
| 14 |
+
|
| 15 |
+
df = pd.read_parquet("hf://datasets/Boredoom17/roman-nepali-corpus/nepali_corpus_roman.parquet")
|
| 16 |
+
print(df.head())
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
## Suggested Workflow
|
| 20 |
+
- Inspect `README.md` first.
|
| 21 |
+
- Review `LICENSE.md` before redistribution.
|
| 22 |
+
- Use the row-level metadata to filter by domain, script, or source.
|