Source code for minari.storage.local

import importlib.metadata
import os
import pathlib
import shutil
import warnings
from typing import Dict, Iterable, Tuple, Union

from minari.dataset.minari_dataset import (
    MinariDataset,
    gen_dataset_id,
    parse_dataset_id,
)
from minari.dataset.minari_storage import MinariStorage
from minari.storage import hosting
from minari.storage.datasets_root_dir import get_dataset_path


# Use importlib due to circular import when: "from minari import __version__"
__version__ = importlib.metadata.version("minari")


def list_non_hidden_dirs(path: str) -> Iterable[str]:
    """List all non-hidden subdirectories."""
    for d in os.scandir(path):
        if d.is_dir() and (not d.name.startswith(".")):
            yield d.name


def dataset_id_sort_key(dataset_id: str) -> Tuple[str, str, int]:
    """Key for sorting dataset ids first by namespace, and then alphabetically."""
    namespace, dataset_name, version = parse_dataset_id(dataset_id)
    namespace = "" if namespace is None else namespace
    return (namespace, dataset_name, version)


[docs] def load_dataset(dataset_id: str, download: bool = False): """Retrieve Minari dataset from local database. Args: dataset_id (str): name id of Minari dataset download (bool): if `True` download the dataset if it is not found locally. Default to `False`. Returns: MinariDataset """ file_path = get_dataset_path(dataset_id) data_path = os.path.join(file_path, "data") if not os.path.exists(data_path): if not download: raise FileNotFoundError( f"Dataset {dataset_id} not found locally at {file_path}. Use download=True to download the dataset." ) hosting.download_dataset(dataset_id) return MinariDataset(data_path)
[docs] def list_local_datasets( latest_version: bool = False, compatible_minari_version: bool = False, ) -> Dict[str, Dict[str, Union[str, int, bool]]]: """Get the ids and metadata of all the Minari datasets in the local database. Args: latest_version (bool): if `True` only the latest version of the datasets are returned i.e. from ['D4RL/door/human-v0', 'D4RL/door/human-v1`], only the metadata for v1 is returned. Default to `False`. compatible_minari_version (bool): if `True` only the datasets compatible with the current Minari version are returned. Default to `False`. Returns: Dict[str, Dict[str, str]]: keys the names of the Minari datasets and values the metadata """ from minari import supported_dataset_versions datasets_path = get_dataset_path("") dataset_ids = [] def recurse_directories(base_path, namespace): parent_dir = os.path.join(base_path, namespace) for dir_name in list_non_hidden_dirs(parent_dir): dir_path = os.path.join(parent_dir, dir_name) namespaced_dir_name = os.path.join(namespace, dir_name) # Minari datasets must contain the data directory. if "data" in os.listdir(dir_path): dataset_ids.append(pathlib.PurePath(namespaced_dir_name).as_posix()) else: recurse_directories(base_path, namespaced_dir_name) recurse_directories(datasets_path, "") dataset_ids = sorted(dataset_ids, key=dataset_id_sort_key) local_datasets = {} for dst_id in dataset_ids: data_path = os.path.join(datasets_path, dst_id, "data") try: metadata = MinariStorage.read_raw_metadata(data_path) metadata_id = metadata["dataset_id"] if dst_id != metadata_id: raise ValueError( f"Namespace location '{dst_id}' does not match id '{metadata_id}'." ) except Exception as e: warnings.warn(f"Misconfigured dataset named {dst_id}: {e}") continue if ( compatible_minari_version and metadata["minari_version"] not in supported_dataset_versions ): continue namespace, dataset_name, version = parse_dataset_id(dst_id) dataset = gen_dataset_id(namespace, dataset_name) if latest_version: if dataset not in local_datasets or version > local_datasets[dataset][0]: local_datasets[dataset] = (version, metadata) else: local_datasets[dst_id] = metadata if latest_version: # Return dict = {'dataset_id': metadata} return dict( map(lambda x: (f"{x[0]}-v{x[1][0]}", x[1][1]), local_datasets.items()) ) else: return local_datasets
[docs] def delete_dataset(dataset_id: str): """Delete a Minari dataset from the local Minari database. Args: dataset_id (str): name id of the Minari dataset """ dataset_path = get_dataset_path(dataset_id) shutil.rmtree(dataset_path) print(f"Dataset {dataset_id} deleted!")