AELYRION-NOULITH-III / docs /UPLOAD_GUIDE.md
PureOne's picture
Add AELYRION-NOULITH III research v3.0.0 (hf.1)
d1c6c9a verified
|
Raw History Blame Contribute Delete
2.62 kB
# Upload workflow
Suggested target: **`PureOne/AELYRION-NOULITH-III`**, repository type **Dataset**.
The release root's uploader sends only the verified `repo/` folder.
## Authentication and execution
Extract the whole release and run `UPLOAD_TO_HUGGINGFACE.bat` on Windows, or
`bash upload_to_huggingface.sh` on Unix. Python 3.11 or newer is required.
The uploader accepts cached Hub CLI credentials or `HF_TOKEN`, then falls back to hidden
token input. A write-capable token for the Dataset repository is required; read-only
connected-app credentials cannot perform a live upload. Token strings are neither echoed
nor saved in the release.
`python upload_to_huggingface.py --dry-run` makes no network request.
A live command verifies hashes and uploads only the manifest's file list.
## Existing repositories
Same-path files are updated. Unrelated remote files remain. Repository visibility is
unchanged if it already exists. The default creates a new public repository; `--private`
creates a new private one. The script does not delete repositories or post discussions.
Older remote files are not cleaned up automatically. The new card explicitly selects the
ten current configurations, preventing unrelated CSV schemas from being merged.
## Troubleshooting
| Problem | Next action |
|---|---|
| Python missing / too old | Install Python 3.11 or newer |
| Dependency download fails | Install `requirements-upload.txt` when connectivity is available |
| HTTP 401 / 403 | Use a valid token with write access to the target repository |
| Namespace mismatch | Use the authenticated account or a listed organization |
| HTTP 429 | Wait for the Hub limit to clear, then rerun |
| Interrupted connection | Rerun against the same repository ID |
| Hash mismatch | Restore delivered files or deliberately regenerate checksums after review |
Do not place a token file inside `repo/`.
## Viewer and citation
Local loading of all ten data configurations is checked. Hub-side Dataset Viewer processing
will run after deposition; it has not been exercised by this preparation task.
Record the actual commit URL printed by the uploader. Use its revision for exact snapshot
reproduction. No remote commit hash or DOI is invented in this package.
## Official documentation
- [Dataset manual configuration](https://huggingface.co/docs/hub/datasets-manual-configuration)
- [Upload files using the Hub SDK](https://huggingface.co/docs/huggingface_hub/guides/upload)
- [Authentication](https://huggingface.co/docs/huggingface_hub/quick-start#authentication)
- [Dataset cards](https://huggingface.co/docs/hub/datasets-cards)