File

less than a minute

File is a class associated with a file saved by wandb.

File(
    client, attrs, run=None
)
Python

Attributes
`path_uri`	Returns the uri path to the file in the storage bucket.

Methods

delete()

display(
    height=420, hidden=(False)
) -> bool
Python

Display this object in jupyter.

download(
    root: str = ".",
    replace: bool = (False),
    exist_ok: bool = (False),
    api: Optional[Api] = None
) -> io.TextIOWrapper
Python

Downloads a file previously saved by a run from the wandb server.

Args
replace (boolean): If `True`, download will overwrite a local file if it exists. Defaults to `False`. root (str): Local directory to save the file. Defaults to “.”. exist_ok (boolean): If `True`, will not raise ValueError if file already exists and will not re-download unless replace=True. Defaults to `False`. api (Api, optional): If given, the `Api` instance used to download the file.

Raises
`ValueError` if file already exists, replace=False and exist_ok=False.

snake_to_camel(
    string
)
Python

to_html(
    *args, **kwargs
)
Python

Was this page helpful?

Sorry to hear that. Please tell us how we can improve.

Last modified March 10, 2025: 9247365