Files
dgl/docs/source/api/python/dgl.data.rst
Minjie Wang 5152a87982 [Data] Utility function and class for converting a dataset for node prediction (#3695)
* add ut

* add doc link

* install dep

* fix  ci

* fix ut; more comments

* remove deprecated attributes in rdf datasets; fix label feature name

* address comments

* fix ut for other frameworks
2022-01-30 14:31:37 +08:00

255 lines
5.0 KiB
ReStructuredText

.. _apidata:
dgl.data
=========
.. currentmodule:: dgl.data
.. automodule:: dgl.data
Quick links:
* `Node Prediction Datasets`_
* `Edge Prediction Datasets`_
* `Graph Prediction Datasets`_
Base Dataset Class
---------------------------
.. autoclass:: DGLDataset
:members: download, save, load, process, has_cache, __getitem__, __len__
Node Prediction Datasets
---------------------------------------
DGL hosted datasets for node classification/regression tasks.
.. _sstdata:
Stanford sentiment treebank dataset
```````````````````````````````````
.. autoclass:: SSTDataset
:members: __getitem__, __len__
.. _karateclubdata:
Karate club dataset
```````````````````````````````````
.. autoclass:: KarateClubDataset
:members: __getitem__, __len__
.. _citationdata:
Citation network dataset
```````````````````````````````````
.. autoclass:: CoraGraphDataset
:members: __getitem__, __len__
.. autoclass:: CiteseerGraphDataset
:members: __getitem__, __len__
.. autoclass:: PubmedGraphDataset
:members: __getitem__, __len__
.. _corafulldata:
CoraFull dataset
```````````````````````````````````
.. autoclass:: CoraFullDataset
:members: __getitem__, __len__
.. _rdfdata:
RDF datasets
```````````````````````````````````
.. autoclass:: AIFBDataset
:members: __getitem__, __len__
.. autoclass:: MUTAGDataset
:members: __getitem__, __len__
.. autoclass:: BGSDataset
:members: __getitem__, __len__
.. autoclass:: AMDataset
:members: __getitem__, __len__
.. _amazoncobuydata:
Amazon Co-Purchase dataset
```````````````````````````````````
.. autoclass:: AmazonCoBuyComputerDataset
:members: __getitem__, __len__
.. autoclass:: AmazonCoBuyPhotoDataset
:members: __getitem__, __len__
.. _coauthordata:
Coauthor dataset
```````````````````````````````````
.. autoclass:: CoauthorCSDataset
:members: __getitem__, __len__
.. autoclass:: CoauthorPhysicsDataset
:members: __getitem__, __len__
.. _ppidata:
Protein-Protein Interaction dataset
```````````````````````````````````
.. autoclass:: PPIDataset
:members: __getitem__, __len__
.. _redditdata:
Reddit dataset
``````````````
.. autoclass:: RedditDataset
:members: __getitem__, __len__
.. _sbmdata:
Symmetric Stochastic Block Model Mixture dataset
````````````````````````````````````````````````
.. autoclass:: SBMMixtureDataset
:members: __getitem__, __len__, collate_fn
.. _frauddata:
Fraud dataset
``````````````
.. autoclass:: FraudDataset
:members: __getitem__, __len__
.. autoclass:: FraudYelpDataset
:members: __getitem__, __len__
.. autoclass:: FraudAmazonDataset
:members: __getitem__, __len__
Edge Prediction Datasets
---------------------------------------
DGL hosted datasets for edge classification/regression and link prediction tasks.
.. _kgdata:
Knowlege graph dataset
```````````````````````````````````
.. autoclass:: FB15k237Dataset
:members: __getitem__, __len__
.. autoclass:: FB15kDataset
:members: __getitem__, __len__
.. autoclass:: WN18Dataset
:members: __getitem__, __len__
.. _bitcoinotcdata:
BitcoinOTC dataset
```````````````````````````````````
.. autoclass:: BitcoinOTCDataset
:members: __getitem__, __len__
ICEWS18 dataset
```````````````````````````````````
.. autoclass:: ICEWS18Dataset
:members: __getitem__, __len__
GDELT dataset
```````````````````````````````````
.. autoclass:: GDELTDataset
:members: __getitem__, __len__
Graph Prediction Datasets
---------------------------------------
DGL hosted datasets for graph classification/regression tasks.
.. _qm7bdata:
QM7b dataset
```````````````````````````````````
.. autoclass:: QM7bDataset
:members: __getitem__, __len__
.. _qm9data:
QM9 dataset
```````````````````````````````````
.. autoclass:: QM9Dataset
:members: __getitem__, __len__
.. _qm9edgedata:
QM9Edge dataset
```````````````````````````````````
.. autoclass:: QM9EdgeDataset
:members: __getitem__, __len__
.. _minigcdataset:
Mini graph classification dataset
`````````````````````````````````
.. autoclass:: MiniGCDataset
:members: __getitem__, __len__
.. _tudata:
TU dataset
``````````
.. autoclass:: TUDataset
:members: __getitem__, __len__
.. autoclass:: LegacyTUDataset
:members: __getitem__, __len__
.. _gindataset:
Graph isomorphism network dataset
```````````````````````````````````
.. autoclass:: GINDataset
:members: __getitem__, __len__
.. _fakenewsdata:
Fake news dataset
```````````````````````````````````
.. autoclass:: FakeNewsDataset
:members: __getitem__, __len__
Dataset adapters
```````````````````````````````````
.. autoclass:: AsNodePredDataset
:members: __getitem__, __len__
Utilities
-----------------
.. autosummary::
:toctree: ../../generated/
utils.get_download_dir
utils.download
utils.check_sha1
utils.extract_archive
utils.split_dataset
utils.load_labels
utils.save_info
utils.load_info
utils.add_nodepred_split
.. autoclass:: dgl.data.utils.Subset
:members: __getitem__, __len__