returnn.__main__

Main entry point

This is the main entry point, providing main(). See init_config() for some arguments, or just run ./rnn.py --help. See Technological Overview for a technical overview.

returnn.__main__.init_config(config_filename: str | None = None, command_line_options: Sequence[str] = (), default_config: Dict[str, Any] | None = None, extra_updates: Dict[str, Any] | None = None)

Parameters:

• config_filename –

• command_line_options – e.g. sys.argv[1:]

• default_config –

• extra_updates –

Initializes the global config. There are multiple sources which are used to init the config:

• configFilename, and maybe first item of commandLineOptions interpret as config filename

• other options via commandLineOptions

• extra_updates

Note about the order/priority of these:

• extra_updates

• options from commandLineOptions

• configFilename

• config filename from commandLineOptions[0]

• extra_updates

• options from commandLineOptions

extra_updates and commandLineOptions are used twice so that they are available when the config is loaded, which thus has access to them, and can e.g. use them via Python code. However, the purpose is that they overwrite any option from the config; that is why we apply them again in the end.

commandLineOptions is applied after extra_updates so that the user has still the possibility to overwrite anything set by extra_updates.

returnn.__main__.init_log()

Initializes the global Log.

returnn.__main__.get_cache_byte_sizes()

Return type:

(int,int,int)

:returns cache size in bytes for (train,dev,eval)

returnn.__main__.load_data(config, cache_byte_size, files_config_key, **kwargs)

Parameters:

• config (Config) –

• cache_byte_size (int) –

• files_config_key (str) – such as “train” or “dev”

• kwargs – passed on to init_dataset() or init_dataset_via_str()

Return type:

(Dataset,int)

:returns the dataset, and the cache byte size left over if we cache the whole dataset.

returnn.__main__.init_data()

Initializes the globals train,dev,eval of type Dataset.

returnn.__main__.setup_dummy_datasets()

setup config to use DummyGenericDataset instead of the normal datasets

returnn.__main__.print_task_properties()

print information about used data

returnn.__main__.init_engine()

Initializes global engine, for example returnn.tf.engine.Engine.

returnn.__main__.returnn_greeting(config_filename=None, command_line_options=None)

Prints some RETURNN greeting to the log.

Parameters:

• config_filename (str|None) –

• command_line_options (list[str]|None) –

returnn.__main__.init_backend_engine(*, config_opts: Dict[str, Any] | None = None)

Selects the backend engine (TensorFlow, PyTorch, Theano, or whatever) and does corresponding initialization and preparation.

This does not initialize the global engine object yet. See init_engine() for that.

This also initializes a new config, if it was not initialized yet, and allows to update it via config_opts.

Parameters:

config_opts – to update the global config

returnn.__main__.init(config_filename=None, command_line_options=(), config_updates=None, extra_greeting=None)

Parameters:

• config_filename (str|None) –

• command_line_options (tuple[str]|list[str]|None) – e.g. sys.argv[1:]

• config_updates (dict[str]|None) – see init_config()

• extra_greeting (str|None) –

returnn.__main__.finalize(error_occurred=False)

Cleanup at the end.

Parameters:

error_occurred (bool) –

returnn.__main__.need_data()

Returns:

whether we need to init the data (call init_data()) for the current task (execute_main_task())

Return type:

bool

returnn.__main__.execute_main_task()

Executes the main task (via config task option).

returnn.__main__.analyze_data(config)

Parameters:

config (Config) –

returnn.__main__.main(argv=None)

Main entry point of RETURNN.

Parameters:

argv (list[str]|None) – sys.argv by default