Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jteijema authored Sep 24, 2021
1 parent fc643d1 commit 6536f29
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
MIT license

0 comments on commit 6536f29

Please sign in to comment.