Skip to content

Commit 4239ec3

Browse files
authored
Merge pull request #135 from py-why/load_dataset
updated doc
2 parents cd5943e + 74554e6 commit 4239ec3

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _datasets:
2+
3+
Datasets
4+
==============================================
5+
6+
7+
8+
Usage
9+
----------------------------
10+
.. code-block:: python
11+
12+
from causallearn.utils.Dataset import load_dataset
13+
14+
data, labels = load_dataset(dataset_name)
15+
16+
Parameters
17+
-------------------
18+
**dataset_name**: str, the name of a dataset in ['sachs', 'boston_housing', 'airfoil']
19+
20+
21+
Returns
22+
-------------------
23+
24+
**data**: np.array, data with a shape of (number of samples, number of variables).
25+
26+
**labels**: list, labels of variables in the data.
27+

docs/source/utilities_index/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Contents:
1010

1111
Graph operations/index
1212
Evaluations
13+
Datasets

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
with open('README.md', 'r') as fh:
44
README = fh.read()
55

6-
VERSION = '0.1.3.5'
6+
VERSION = '0.1.3.6'
77

88
setuptools.setup(
99
name='causal-learn',

0 commit comments

Comments
 (0)