zea.setup

zea.setup(config_path=None, user_config=None, verbose=True, disable_config_check=False, loader=<class 'yaml.loader.FullLoader'>, create_user=False, **kwargs)[source]

General setup function for zea. Loads config, sets data paths and initializes gpu if available. Will return config object.

Parameters:

  • config_path (str) – file path to config yaml. Defaults to None, in which case a window dialog will pop up.

  • user_config (Union[str, dict]) – path that points to yaml file with user info. Alternively dictionary with user info. Defaults to None.

  • verbose (bool) – print config file path and git summary. Defaults to True.

  • disable_config_check (bool) – whether to check for zea config validity. Defaults to False. Can be set to True if you are using some other config that does not have to adhere to zea config standards.

  • loader (yaml.Loader, optional) – yaml loader. Defaults to yaml.FullLoader.

  • create_user (bool) – whether to create a new user. Defaults to False. If True, it will prompt the user to enter their datapaths.

  • **kwargs – Additional keyword arguments forwarded to Config.from_path for hf:// configs, for example repo_type or revision.

Returns:

config object / dict.

Return type:

config (dict)