Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
rishabh-ranjan committed Jul 8, 2024
1 parent 533f423 commit fd5d168
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
9 changes: 8 additions & 1 deletion relbench/datasets/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,14 @@ def get_dataset(name: str, download=False) -> Dataset:
Returns:
Dataset: The dataset object.
If `download` is True, the dataset will be downloaded into the cache.
If `download` is True, the database comprising the dataset will be
downloaded into the cache from the RelBench server. If you use
`download=False` the first time, the database will be processed from the
raw files of the original source.
Once the database is cached, either because of download or processing from
raw files, the cache will be used. `download=True` will verify that the
cached database matches the RelBench version even in this case.
"""

if download:
Expand Down
9 changes: 8 additions & 1 deletion relbench/tasks/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,14 @@ def get_task(dataset_name: str, task_name: str, download=False) -> BaseTask:
Returns:
BaseTask: The task object.
If `download` is True, the task will be downloaded into the cache.
If `download` is True, the task tables (train, val, test) comprising the
task will be downloaded into the cache from the RelBench server. If you use
`download=False` the first time, the task tables will be computed from
scratch using the database.
Once the task tables are cached, either because of download or computing from
scratch, the cache will be used. `download=True` will verify that the
cached task tables matches the RelBench version even in this case.
"""

if download:
Expand Down

0 comments on commit fd5d168

Please sign in to comment.