Skip to content

Commit

Permalink
removing doc ref to DatasetV2 class
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrewq11 committed Dec 12, 2024
1 parent fd9f119 commit ffbb2e9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions polaris/competition/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

class CompetitionSpecification(DatasetV2):
"""An instance of this class represents a Polaris competition. It defines fields and functionality
that in combination with the [`DatasetV2`][polaris.experimental._dataset_v2.DatasetV2] class, allow
that in combination with the `polaris.experimental._dataset_v2.DatasetV2` class, allow
users to participate in competitions hosted on Polaris Hub.
Examples:
Expand Down Expand Up @@ -80,7 +80,8 @@ class CompetitionSpecification(DatasetV2):
n_test_sets: The number of test sets defined in the test split.
n_test_datapoints: The number of datapoints in each test set.
n_classes: The number of classes within target columns that define a classification task.
For additional meta-data attributes, see the [`DatasetV2`][polaris.experimental._dataset_v2.DatasetV2] class.
For additional meta-data attributes, see the `polaris.experimental._dataset_v2.DatasetV2` class.
"""

_artifact_type = "competition"
Expand Down
2 changes: 1 addition & 1 deletion polaris/experimental/_dataset_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class DatasetV2(BaseDataset):
Attributes:
zarr_root_path: The path to the Zarr archive. Different from V1, this is now required.
For additional meta-data attributes, see the [`BaseDataset`][polaris._dataset.BaseDataset] class.
For additional meta-data attributes, see the [`BaseDataset`][polaris.dataset._base.BaseDataset] class.
Raises:
InvalidDatasetError: If the dataset does not conform to the Pydantic data-model specification.
Expand Down

0 comments on commit ffbb2e9

Please sign in to comment.