Skip to content

Commit

Permalink
Merge pull request #2832 from activeloopai/docs_fix
Browse files Browse the repository at this point in the history
docs fix
  • Loading branch information
activesoull committed Apr 26, 2024
2 parents 08146b6 + 2f3267d commit 008c897
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 6 deletions.
4 changes: 2 additions & 2 deletions deeplake/core/dataset/dataset.py
Expand Up @@ -2183,14 +2183,14 @@ def pytorch(
return dataloader

def dataloader(self, ignore_errors: bool = False, verbose: bool = False):
"""Returns a :class:`~deeplake.enterprise.DeepLakeDataLoader` object.
"""Returns a :class:`~deeplake.enterprise.dataloader.DeepLakeDataLoader` object.
Args:
ignore_errors (bool): If ``True``, the data loader will ignore errors appeared during data iteration otherwise it will collect the statistics and report appeared errors. Default value is ``False``
verbose (bool): If ``True``, the data loader will dump verbose logs of it's steps. Default value is ``False``
Returns:
~deeplake.enterprise.DeepLakeDataLoader: A :class:`deeplake.enterprise.DeepLakeDataLoader` object.
~deeplake.enterprise.dataloader.DeepLakeDataLoader: A :class:`deeplake.enterprise.dataloader.DeepLakeDataLoader` object.
Examples:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Dataloader.rst
Expand Up @@ -17,7 +17,7 @@ See the ``dataloader`` method on how to create dataloaders from your datasets:
DeepLakeDataLoader
~~~~~~~~~~~~~~~~~~

.. currentmodule:: deeplake.enterprise
.. currentmodule:: deeplake.enterprise.dataloader

.. autoclass:: DeepLakeDataLoader()
:members:
3 changes: 0 additions & 3 deletions docs/source/deeplake.util.exceptions.rst
Expand Up @@ -296,9 +296,6 @@ deeplake.util.exceptions
.. autoclass:: AgreementNotAcceptedError
:show-inheritance:

.. autoclass:: NotLoggedInError
:show-inheritance:

.. autoclass:: RenameError
:show-inheritance:

Expand Down

0 comments on commit 008c897

Please sign in to comment.