From 74554e6d17f59cfded63f59b1e7fed6df57c2e26 Mon Sep 17 00:00:00 2001 From: kunwuz <514397511@qq.com> Date: Fri, 22 Sep 2023 01:57:52 -0400 Subject: [PATCH] updated doc --- docs/source/utilities_index/Datasets.rst | 27 ++++++++++++++++++++++++ docs/source/utilities_index/index.rst | 1 + setup.py | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/source/utilities_index/Datasets.rst diff --git a/docs/source/utilities_index/Datasets.rst b/docs/source/utilities_index/Datasets.rst new file mode 100644 index 00000000..fad90d9a --- /dev/null +++ b/docs/source/utilities_index/Datasets.rst @@ -0,0 +1,27 @@ +.. _datasets: + +Datasets +============================================== + + + +Usage +---------------------------- +.. code-block:: python + + from causallearn.utils.Dataset import load_dataset + + data, labels = load_dataset(dataset_name) + +Parameters +------------------- +**dataset_name**: str, the name of a dataset in ['sachs', 'boston_housing', 'airfoil'] + + +Returns +------------------- + +**data**: np.array, data with a shape of (number of samples, number of variables). + +**labels**: list, labels of variables in the data. + diff --git a/docs/source/utilities_index/index.rst b/docs/source/utilities_index/index.rst index c175e226..ec4dfc83 100644 --- a/docs/source/utilities_index/index.rst +++ b/docs/source/utilities_index/index.rst @@ -10,3 +10,4 @@ Contents: Graph operations/index Evaluations + Datasets diff --git a/setup.py b/setup.py index 66781037..49cdb7c0 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ with open('README.md', 'r') as fh: README = fh.read() -VERSION = '0.1.3.5' +VERSION = '0.1.3.6' setuptools.setup( name='causal-learn',