Skip to content
Permalink
Browse files

Clearer deprecation notes for FB15k, WN18

  • Loading branch information...
lukostaz committed Aug 15, 2019
1 parent 99a4d3c commit 8915de5713f0a01d306d3d3e0c9f6da6402b638d
Showing with 17 additions and 19 deletions.
  1. +8 −10 ampligraph/datasets/datasets.py
  2. +9 −9 docs/ampligraph.datasets.rst
@@ -329,6 +329,10 @@ def _load_dataset(dataset_metadata, data_home=None, check_md5hash=False):
def load_wn18(check_md5hash=False):
"""Load the WN18 dataset
.. warning::
The dataset includes a large number of inverse relations that spilled to the test set, and its use in
experiments has been deprecated. Use WN18RR instead.
WN18 is a subset of Wordnet. It was first presented by :cite:`bordes2013translating`.
The WN18 dataset is loaded from file if it exists at the ``AMPLIGRAPH_DATA_HOME`` location.
@@ -349,11 +353,6 @@ def load_wn18(check_md5hash=False):
WN18 141,442 5,000 5,000 40,943 18
========= ========= ======= ======= ============ ===========
.. warning::
The dataset includes a large number of inverse relations, and its use in experiments has been deprecated.
Use WN18RR instead.
Parameters
----------
check_md5hash : bool
@@ -463,6 +462,10 @@ def load_wn18rr(check_md5hash=False, clean_unseen=True):
def load_fb15k(check_md5hash=False):
"""Load the FB15k dataset
.. warning::
The dataset includes a large number of inverse relations that spilled to the test set, and its use in
experiments has been deprecated. Use FB15k-237 instead.
FB15k is a split of Freebase, first proposed by :cite:`bordes2013translating`.
The FB15k dataset is loaded from file if it exists at the ``AMPLIGRAPH_DATA_HOME`` location.
@@ -483,11 +486,6 @@ def load_fb15k(check_md5hash=False):
FB15K 483,142 50,000 59,071 14,951 1,345
========= ========= ======= ======= ============ ===========
.. warning::
The dataset includes a large number of inverse relations, and its use in experiments has been deprecated.
Use FB15k-237 instead.
Parameters
----------
check_md5hash : boolean
@@ -4,6 +4,7 @@ Datasets

.. automodule:: ampligraph.datasets


.. note::
It is recommended to set the ``AMPLIGRAPH_DATA_HOME`` environment variable::

@@ -17,8 +18,8 @@ Datasets

~/ampligraph_datasets

Dataset-Specific Loaders
^^^^^^^^^^^^^^^^^^^^^^^^
Benchmark Datasets Loaders
^^^^^^^^^^^^^^^^^^^^^^^^^^

Use these helpers functions to load datasets used in graph representation learning literature.
The functions will **automatically download** the datasets if they are not present in ``~/ampligraph_datasets`` or
@@ -30,12 +31,11 @@ at the location set in ``AMPLIGRAPH_DATA_HOME``.
:toctree: generated
:template: function.rst

load_wn18
load_fb15k
load_fb15k_237
load_yago3_10
load_wn18rr

load_yago3_10
load_fb15k
load_wn18


**Datasets Summary**
@@ -51,7 +51,7 @@ YAGO3-10 1,079,040 5,000 5,000 123,182 37
========= ========= ======= ======= ============ ===========


.. hint::
.. warning::
WN18 and FB15k include a large number of inverse relations, and its use in experiments has been deprecated.
**Use WN18RR and FB15K-237 instead**.

@@ -60,8 +60,8 @@ YAGO3-10 1,079,040 5,000 5,000 123,182 37
distributed over 28 triples. WN18RR's validation set contains 198 unseen entities over 210 triples. The test set
has 209 unseen entities, distributed over 210 triples.

Generic Loaders
^^^^^^^^^^^^^^^
Loaders for Custom Knowledge Graphs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Functions to load custom knowledge graphs from disk.

0 comments on commit 8915de5

Please sign in to comment.
You can’t perform that action at this time.