Clarify Croissant availability and requirements for private datasets
Browse files
README.md
CHANGED
|
@@ -97,12 +97,20 @@ Class IDs are globally consistent across all sites.
|
|
| 97 |
|
| 98 |
## Croissant status
|
| 99 |
|
| 100 |
-
The Hub `/croissant` endpoint currently returns unavailable for this dataset (no Hub-parquet representation yet).
|
| 101 |
-
|
| 102 |
Endpoint:
|
| 103 |
|
| 104 |
```text
|
| 105 |
https://huggingface.co/api/datasets/kangnicui2/GoldMiningMDD/croissant
|
| 106 |
```
|
| 107 |
|
| 108 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 97 |
|
| 98 |
## Croissant status
|
| 99 |
|
|
|
|
|
|
|
| 100 |
Endpoint:
|
| 101 |
|
| 102 |
```text
|
| 103 |
https://huggingface.co/api/datasets/kangnicui2/GoldMiningMDD/croissant
|
| 104 |
```
|
| 105 |
|
| 106 |
+
Current behavior for this repository: the endpoint is not available yet.
|
| 107 |
+
|
| 108 |
+
Important platform note: the Hugging Face Dataset Viewer/Croissant service is powered by `datasets-server`, and private datasets require a plan that supports private dataset-server features (for many accounts this means PRO/Enterprise).
|
| 109 |
+
|
| 110 |
+
How to get Croissant for this dataset:
|
| 111 |
+
|
| 112 |
+
1. Keep this repo as dataset format compatible with Parquet conversion (already fine for Hub processing).
|
| 113 |
+
2. Make sure dataset-server can run on this repo:
|
| 114 |
+
- Option A: make the dataset public; or
|
| 115 |
+
- Option B: use an account/org plan that supports private dataset-server.
|
| 116 |
+
3. Once processed, query the endpoint above and use the returned JSON-LD as machine-readable Croissant metadata.
|