Skip to content

namegen

darts_utils.namegen

Random name generator.

generate_counted_name 

generate_counted_name(artifact_dir: pathlib.Path) -> str

Generate a random name with a count attached.

The count is calculated by the number of existing directories in the specified artifact directory. The final name is in the format '{somename}-{somesecondname}-{count+1}'.

Parameters:

  • artifact_dir (pathlib.Path) –

    The directory of existing runs.

Returns:

  • str ( str ) –

    The final name.

Source code in darts-utils/src/darts_utils/namegen.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def generate_counted_name(artifact_dir: Path) -> str:
    """Generate a random name with a count attached.

    The count is calculated by the number of existing directories in the specified artifact directory.
    The final name is in the format '{somename}-{somesecondname}-{count+1}'.

    Args:
        artifact_dir (Path): The directory of existing runs.

    Returns:
        str: The final name.

    """
    from names_generator import generate_name as _generate_name

    run_name = _generate_name(style="hyphen")
    # Count the number of existing runs in the artifact_dir, increase the number by one and append it to the name
    run_count = sum(1 for p in artifact_dir.glob("*") if p.is_dir())
    run_name = f"{run_name}-{run_count + 1}"
    return run_name

generate_id 

generate_id(length: int = 8) -> str

Generate a random base-36 string of length digits.

This method is taken from the wandb SDK.

There are ~2.8T base-36 8-digit strings. Generating 210k ids will have a ~1% chance of collision.

Parameters:

  • length (int, default: 8 ) –

    The length of the string. Defaults to 8.

Returns:

  • str ( str ) –

    A random base-36 string of length digits.

Source code in darts-utils/src/darts_utils/namegen.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
def generate_id(length: int = 8) -> str:
    """Generate a random base-36 string of `length` digits.

    This method is taken from the wandb SDK.

    There are ~2.8T base-36 8-digit strings. Generating 210k ids will have a ~1% chance of collision.

    Args:
        length (int, optional): The length of the string. Defaults to 8.

    Returns:
        str: A random base-36 string of `length` digits.

    """
    alphabet = string.ascii_lowercase + string.digits
    return "".join(secrets.choice(alphabet) for _ in range(length))

generate_name 

generate_name() -> str

Generate a random name.

Returns:

  • str ( str ) –

    The final name.

Source code in darts-utils/src/darts_utils/namegen.py 
26
27
28
29
30
31
32
33
34
35
def generate_name() -> str:
    """Generate a random name.

    Returns:
        str: The final name.

    """
    from names_generator import generate_name as _generate_name

    return _generate_name(style="hyphen")