Skip to content

Save

model_navigator.api.package.save 

model_navigator.api.package.save(package, path, override=False, save_data=True)

Save export results into the .nav package at given path.

Parameters:

  • package (Package) –

    A package object to prepare the package

  • path (Union[str, pathlib.Path]) –

    A path to file where the package has to be saved

  • override (bool, default: False ) –

    flag to override existing package in provided path

  • save_data (bool, default: True ) –

    disable saving samples from the dataloader

Source code in model_navigator/api/package.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def save(
    package: Package,
    path: Union[str, pathlib.Path],
    override: bool = False,
    save_data: bool = True,
) -> None:
    """Save export results into the .nav package at given path.

    Args:
        package: A package object to prepare the package
        path: A path to file where the package has to be saved
        override: flag to override existing package in provided path
        save_data: disable saving samples from the dataloader
    """
    builder = PackageBuilder()
    builder.save(
        package=package,
        path=path,
        override=override,
        save_data=save_data,
    )