Skip to content

raesl.datasets

Datasets module. Contains various ESL datasets (see :obj:enum(), :obj:get(), and :obj:info).

check 

check(name: str)

Check whether a dataset exists.

Source code in src/raesl/datasets/__init__.py 
24
25
26
27
28
29
30
def check(name: str):
    """Check whether a dataset exists."""
    available = enum()
    if name not in available:
        raise ValueError(
            "Dataset {} cannot be found. Please pick one of {}.".format(name, available)
        )

copy 

copy(
    name: str, output_path: str, as_file: bool = False
) -> None

Copy a dataset into a directory or file.

Source code in src/raesl/datasets/__init__.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def copy(name: str, output_path: str, as_file: bool = False) -> None:
    """Copy a dataset into a directory or file."""
    check(name)
    p = Path(output_path)
    p.parent.mkdir(exist_ok=True, parents=True)

    loc = HERE / name
    files = [f for f in (HERE / name).glob("**/*.esl")]

    if as_file:
        p.write_text("\n\n".join(f.read_text() for f in files))
    else:
        if p.exists() and any(p.iterdir()):
            raise ValueError(f"Directory {p} already exists and is not empty.")

        for f in files:
            dest = p / f.relative_to(loc)
            dest.parent.mkdir(exist_ok=True, parents=True)
            shutil.copy(f, dest)

enum 

enum() -> List[str]

Enumerate all available datasets.

Source code in src/raesl/datasets/__init__.py 
13
14
15
16
17
18
19
20
21
def enum() -> List[str]:
    """Enumerate all available datasets."""
    return sorted(
        [
            d.name
            for d in HERE.iterdir()
            if d.is_dir() and not d.name.startswith(".") and not d.name.startswith("_")
        ]
    )

get 

get(name: str)

Get a dataset.

Parameters:

Name Type Description Default
name str

Name of the dataset to get (see ragraph.datasets.enum()).

 required
Source code in src/raesl/datasets/__init__.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def get(name: str):
    """Get a dataset.

    Arguments:
        name: Name of the dataset to get (see `ragraph.datasets.enum()`).
    """
    from ragraph.io.esl import from_esl

    check(name)

    graph = from_esl(HERE / name)
    graph.kind = name

    return graph

info 

info(name: str) -> str

Get information about a dataset.

Source code in src/raesl/datasets/__init__.py 
33
34
35
36
37
38
def info(name: str) -> str:
    """Get information about a dataset."""
    check(name)
    mod = importlib.import_module(f"raesl.datasets.{name}")
    doc = mod.__doc__
    return str(doc)