Dataset
data.Dataset(self, name, **kwargs)
Dataset provides methods to load and describe datasets.
Notes
You cannot manually instantiate this class. Use the class methods instead, e.g. Dataset.load()
. You can also pass additional allow_instantiation=True
to bypass this restriction.
Parameters
Name | Type | Description | Default |
---|---|---|---|
name |
str | the name to the dataset file. Use list_datasets to see available datasets. |
required |
kwargs |
dict | additional arguments. | {} |
Raises
Type | Description |
---|---|
NotImplementedError | you cannot instantiate this class. Use the class methods instead. |
Methods
Name | Description |
---|---|
open | Open the dataset with the given name, and optionally download it if it does not exist. |
where | Filter the dataset given some selectors. |
describe | Provides metadata and information card for the dataset. |
load | Load the dataset with the given name. |
validate | Simple validations to check if the dataset is valid and consistent. |