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.

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

Already on GitHub? Sign in to your account

[AL-2322] Improved dataset directory validation #2459

Merged
merged 6 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ logs/
.vscode/
.creds/
.idea/
*.iml
.nvimrc
.vimrc
waymo/
Expand All @@ -213,5 +214,8 @@ benchmarks/hub_data
benchmarks/torch_data
.benchmarks/

deeplake/test-dataset
nvoxland marked this conversation as resolved.
Show resolved Hide resolved

# API docs
api_docs/

2 changes: 2 additions & 0 deletions deeplake/core/dataset/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
)
from deeplake.util.keys import (
dataset_exists,
dataset_validate,
get_dataset_info_key,
get_dataset_meta_key,
tensor_exists,
Expand Down Expand Up @@ -1760,6 +1761,7 @@ def diff(
def _populate_meta(self, verbose=True):
"""Populates the meta information for the dataset."""
if dataset_exists(self.storage):
dataset_validate(self.storage)
nvoxland marked this conversation as resolved.
Show resolved Hide resolved
load_meta(self)

elif not self.storage.empty():
Expand Down
28 changes: 25 additions & 3 deletions deeplake/util/keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
S3GetError,
S3GetAccessError,
AuthorizationException,
DatasetCorruptError,
)


Expand Down Expand Up @@ -183,15 +184,36 @@ def get_sequence_encoder_key(key: str, commit_id: str) -> str:


def dataset_exists(storage) -> bool:
"""
Returns true if a dataset exists at the given location.
NOTE: This does not verify if it is a VALID dataset, only that it exists and is likely a deeplake directory.
To verify the content, use :func:`dataset_valid`
nvoxland marked this conversation as resolved.
Show resolved Hide resolved
"""
try:
storage[get_dataset_meta_key(FIRST_COMMIT_ID)]
return True
return (
get_dataset_meta_key(FIRST_COMMIT_ID) in storage
or get_version_control_info_key() in storage
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious is it enough to check only these things? Shouldn't we also check whether chunks exists?

except S3GetAccessError as err:
raise AuthorizationException("The dataset storage cannot be accessed") from err
except (KeyError, S3GetError) as err:
except S3GetError:
nvoxland marked this conversation as resolved.
Show resolved Hide resolved
return False


def dataset_validate(storage) -> None:
"""
Checks the structure of the dataset and throws a descriptive DatasetCorruptError for any problems.
"""
try:
for file in [get_dataset_meta_key(FIRST_COMMIT_ID), get_version_control_info_key()]:
nvoxland marked this conversation as resolved.
Show resolved Hide resolved
if file not in storage:
raise DatasetCorruptError(f"Invalid dataset: missing file {file}")
except S3GetAccessError as err:
raise AuthorizationException("The dataset storage cannot be accessed") from err
except S3GetError:
nvoxland marked this conversation as resolved.
Show resolved Hide resolved
raise DatasetCorruptError("Error reading from S3")


def tensor_exists(key: str, storage, commit_id: str) -> bool:
try:
storage[get_tensor_meta_key(key, commit_id)]
Expand Down
Loading