API Reference

• benchmarking package
  • Submodules
    • benchmarking.baselines module
      • MethodArguments
      • Methods
    • benchmarking.benchmark_main module
    • benchmarking.benchmarks module
    • benchmarking.launch_slurmpilot module
• setup module
• syne_tune package
  • StoppingCriterion
    • StoppingCriterion.max_wallclock_time
    • StoppingCriterion.max_num_evaluations
    • StoppingCriterion.max_num_trials_started
    • StoppingCriterion.max_num_trials_completed
    • StoppingCriterion.max_cost
    • StoppingCriterion.max_num_trials_finished
    • StoppingCriterion.min_metric_value
    • StoppingCriterion.max_metric_value
  • Tuner
    • Tuner.run()
    • Tuner.save()
    • Tuner.load()
    • Tuner.best_config()
  • Reporter
    • Reporter.add_time
  • Subpackages
    • syne_tune.backend package
      • LocalBackend
      • PythonBackend
      • Subpackages
      • Submodules
    • syne_tune.blackbox_repository package
      • BlackboxOffline
      • deserialize()
      • load_blackbox()
      • blackbox_list()
      • add_surrogate()
      • BlackboxRepositoryBackend
      • UserBlackboxBackend
      • Subpackages
      • Submodules
    • syne_tune.callbacks package
      • TensorboardCallback
      • Submodules
    • syne_tune.experiments package
      • ExperimentResult
      • load_experiment()
      • get_metadata()
      • list_experiments()
      • load_experiments_df()
      • hypervolume_indicator_column_generator()
      • Submodules
    • syne_tune.optimizer package
      • Subpackages
      • Submodules
    • syne_tune.utils package
      • add_checkpointing_to_argparse()
      • resume_from_checkpointed_model()
      • checkpoint_model_at_rung_level()
      • pytorch_load_save_functions()
      • parse_bool()
      • add_config_json_to_argparse()
      • load_config_json()
      • streamline_config_space()
      • Submodules
  • Submodules
    • syne_tune.config_space module
      • Domain
      • Sampler
      • BaseSampler
      • Uniform
      • LogUniform
      • Normal
      • Grid
      • Float
      • Integer
      • Categorical
      • Ordinal
      • OrdinalNearestNeighbor
      • FiniteRange
      • uniform()
      • loguniform()
      • randint()
      • lograndint()
      • choice()
      • ordinal()
      • logordinal()
      • finrange()
      • logfinrange()
      • is_log_space()
      • is_reverse_log_space()
      • is_uniform_space()
      • add_to_argparse()
      • cast_config_values()
      • postprocess_config()
      • remove_constant_and_cast()
      • non_constant_hyperparameter_keys()
      • config_space_size()
      • config_to_match_string()
      • to_dict()
      • from_dict()
      • config_space_to_json_dict()
      • config_space_from_json_dict()
      • restrict_domain()
      • Quantized
      • quniform()
      • reverseloguniform()
      • qloguniform()
      • qrandint()
      • qlograndint()
    • syne_tune.constants module
      • SYNE_TUNE_ENV_FOLDER
      • SYNE_TUNE_DEFAULT_FOLDER
      • ST_WORKER_ITER
      • ST_WORKER_TIMESTAMP
      • ST_WORKER_TIME
      • ST_WORKER_COST
      • ST_CHECKPOINT_DIR
      • ST_CONFIG_JSON_FNAME_ARG
      • ST_REMOTE_UPLOAD_DIR_NAME
      • ST_RESULTS_DATAFRAME_FILENAME
      • ST_METADATA_FILENAME
      • ST_TUNER_DILL_FILENAME
      • ST_DATETIME_FORMAT
      • TUNER_DEFAULT_SLEEP_TIME
      • ST_METRIC_TAG
    • syne_tune.num_gpu module
      • get_num_gpus()
    • syne_tune.report module
      • Reporter
      • retrieve()
    • syne_tune.results_callback module
      • ExtraResultsComposer
      • StoreResultsCallback
    • syne_tune.stopping_criterion module
      • StoppingCriterion
      • PlateauStopper
    • syne_tune.tuner module
      • Tuner
    • syne_tune.tuner_callback module
      • TunerCallback
    • syne_tune.tuning_status module
      • MetricsStatistics
      • TuningStatus
      • print_best_metric_found()
    • syne_tune.util module
      • RegularCallback
      • experiment_path()
      • name_from_base()
      • random_string()
      • repository_root_path()
      • script_checkpoint_example_path()
      • script_height_example_path()
      • catchtime()
      • is_increasing()
      • is_positive_integer()
      • is_integer()
      • dump_json_with_numpy()
      • dict_get()
      • recursive_merge()
      • find_first_of_type()
      • metric_name_mode()