clefourrier HF staff commited on
Commit
ae5b03a
1 Parent(s): d7af14e

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +108 -0
README.md ADDED
@@ -0,0 +1,108 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ licence: unknown
3
+ ---
4
+
5
+ # Dataset Card for benzene
6
+
7
+ ## Table of Contents
8
+ - [Table of Contents](#table-of-contents)
9
+ - [Dataset Description](#dataset-description)
10
+ - [Dataset Summary](#dataset-summary)
11
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
12
+ - [External Use](#external-use)
13
+ - [PyGeometric](#pygeometric)
14
+ - [Dataset Structure](#dataset-structure)
15
+ - [Data Properties](#data-properties)
16
+ - [Data Fields](#data-fields)
17
+ - [Data Splits](#data-splits)
18
+ - [Additional Information](#additional-information)
19
+ - [Licensing Information](#licensing-information)
20
+ - [Citation Information](#citation-information)
21
+ - [Contributions](#contributions)
22
+
23
+ ## Dataset Description
24
+ - **[Homepage](http://www.sgdml.org/#datasets)**
25
+ - **Paper:**: (see citation)
26
+
27
+
28
+ ### Dataset Summary
29
+ The `benzene` dataset is molecular dynamics (MD) dataset. The total energy and force labels for each dataset were computed using the PBE+vdW-TS electronic structure method. All geometries are in Angstrom, energies and forces are given in kcal/mol and kcal/mol/A respectively.
30
+
31
+ ### Supported Tasks and Leaderboards
32
+ `benzene` should be used for organic molecular property prediction, a regression task on 1 property. The score used is Mean absolute errors (in meV) for energy prediction.
33
+
34
+
35
+ ## External Use
36
+ ### PyGeometric
37
+ To load in PyGeometric, do the following:
38
+
39
+ ```python
40
+ from datasets import load_dataset
41
+
42
+ from torch_geometric.data import Data
43
+ from torch_geometric.loader import DataLoader
44
+
45
+ dataset_hf = load_dataset("graphs-datasets/<mydataset>")
46
+ # For the train set (replace by valid or test as needed)
47
+ dataset_pg_list = [Data(graph) for graph in dataset_hf["train"]]
48
+ dataset_pg = DataLoader(dataset_pg_list)
49
+ ```
50
+
51
+ ## Dataset Structure
52
+
53
+ ### Data Properties
54
+ | property | value |
55
+ |---|---|
56
+ | scale | big |
57
+ | #graphs | 527983 |
58
+ | average #nodes | 12.0 |
59
+ | average #edges | 129.8848866632322 |
60
+
61
+ ### Data Fields
62
+
63
+ Each row of a given file is a graph, with:
64
+ - `node_feat` (list: #nodes x #node-features): nodes
65
+ - `edge_index` (list: 2 x #edges): pairs of nodes constituting edges
66
+ - `edge_attr` (list: #edges x #edge-features): for the aforementioned edges, contains their features
67
+ - `y` (list: #labels): contains the number of labels available to predict
68
+ - `num_nodes` (int): number of nodes of the graph
69
+
70
+ ### Data Splits
71
+
72
+ This data is not split, and should be used with cross validation. It comes from the PyGeometric version of the dataset.
73
+
74
+ ## Additional Information
75
+
76
+ ### Licensing Information
77
+ The dataset has been released under license unknown.
78
+
79
+ ### Citation Information
80
+ ```
81
+ @inproceedings{Morris+2020,
82
+ title={TUDataset: A collection of benchmark datasets for learning with graphs},
83
+ author={Christopher Morris and Nils M. Kriege and Franka Bause and Kristian Kersting and Petra Mutzel and Marion Neumann},
84
+ booktitle={ICML 2020 Workshop on Graph Representation Learning and Beyond (GRL+ 2020)},
85
+ archivePrefix={arXiv},
86
+ eprint={2007.08663},
87
+ url={www.graphlearning.io},
88
+ year={2020}
89
+ }
90
+ ```
91
+
92
+ ```
93
+
94
+ @article{Chmiela_2017,
95
+ doi = {10.1126/sciadv.1603015},
96
+ url = {https://doi.org/10.1126%2Fsciadv.1603015},
97
+ year = 2017,
98
+ month = {may},
99
+ publisher = {American Association for the Advancement of Science ({AAAS})},
100
+ volume = {3},
101
+ number = {5},
102
+ author = {Stefan Chmiela and Alexandre Tkatchenko and Huziel E. Sauceda and Igor Poltavsky and Kristof T. Schütt and Klaus-Robert Müller},
103
+ title = {Machine learning of accurate energy-conserving molecular force fields},
104
+ journal = {Science Advances}
105
+ }
106
+
107
+
108
+ ```