Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs fix #2832

Merged
merged 1 commit into from Apr 26, 2024
Merged

docs fix #2832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions deeplake/core/dataset/dataset.py
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Expand Up @@ -296,9 +296,6 @@ deeplake.util.exceptions
.. autoclass:: AgreementNotAcceptedError
:show-inheritance:

.. autoclass:: NotLoggedInError
:show-inheritance:

.. autoclass:: RenameError
:show-inheritance:

Expand Down