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

Upload folder using huggingface_hub

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