From 6536f29145e650ec254638be26c3134646444b52 Mon Sep 17 00:00:00 2001 From: Jelle Date: Fri, 24 Sep 2021 17:29:24 +0200 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c996cac..0bafed5 100644 --- a/README.md +++ b/README.md @@ -29,15 +29,18 @@ and replace `{USER_NAME}` and `{REPO_NAME}` by your own details. The new dataset is defined in [`asreviewcontrib/dataset_name/your_dataset.py`](asreviewcontrib\dataset_name\your_dataset.py) -and can be used as a new dataset. By supplying the `from_config()` method with a +and can be used as a new dataset. + +By supplying the `from_config()` method with a config object, a new DataSet object is created, and integrated to ASReview. See -[https://asreview.readthedocs.io/en/latest/API/generated/asreview.datasets.BaseDataSet.html#asreview.datasets.BaseDataSet.from_config] -(asreview.datasets.BaseDataSet.from_config) for more info. +[asreview.datasets.BaseDataSet.from_config](https://asreview.readthedocs.io/en/latest/API/generated/asreview.datasets.BaseDataSet.html#asreview.datasets.BaseDataSet.from_config) +for more information on this function. [`setup.py`](setup.py) contains the code needed for integration into ASReview. -[`asreviewcontrib/dataset_name/__init__.py`](asreviewcontrib/dataset_name/__init__.py) contains directions for loading the dataset module. +[`asreviewcontrib/dataset_name/__init__.py`](asreviewcontrib/dataset_name/__init__.py) +contains directions for loading the dataset module. ## License -MIT license \ No newline at end of file +MIT license