cparidaAI commited on
Commit
cfd064d
·
verified ·
1 Parent(s): 9444719

Delete Readme.md

Browse files
Files changed (1) hide show
  1. Readme.md +0 -35
Readme.md DELETED
@@ -1,35 +0,0 @@
1
- # AI4Materials Demo FAIR Perovskites
2
-
3
- This is a **teaching** dataset demonstrating F.A.I.R. hosting on the Hugging Face Hub.
4
- It contains a small table of oxide perovskites with band gaps and toy EXTXYZ structures.
5
-
6
- ## Contents
7
- - `data/table.csv` — main tabular data
8
- - `data/records.jsonl` — line-delimited JSON mirror
9
- - `data/structures/*.xyz` — example structures (EXTXYZ)
10
- - `metadata/schema.json` — JSON Schema for validation
11
- - `CITATION.cff`, `LICENSE` — citation & reuse terms
12
-
13
- ## Provenance
14
- Synthetic examples generated for classroom demonstration on {datetime.utcnow().date()}.
15
-
16
- ## How to load
17
- ```python
18
- from datasets import load_dataset
19
- ds = load_dataset("cparidaAI/fair_dataset_demo", data_files={"train": "data/table.csv"})
20
- print(ds)
21
- ```
22
- Or download a structure file:
23
- ```python
24
- from huggingface_hub import hf_hub_download
25
- path = hf_hub_download(repo_id="cparidaAI/fair_dataset_demo", filename="data/structures/ABO3_0001.xyz")
26
- ```
27
-
28
- ## License
29
- CC-BY-4.0. Please cite using `CITATION.cff`.
30
-
31
- ## F.A.I.R. checklist
32
- - **F**indable: metadata, tags, README, (add DOI later via Zenodo)
33
- - **A**ccessible: public repo, open formats
34
- - **I**nteroperable: CSV/JSON/EXTXYZ, schema describes fields/units
35
- - **R**eusable: license, clear citation, validation, examples