trinity.manager.config_registry

Submodules

trinity.manager.config_registry.buffer_config_manager module

trinity.manager.config_registry.buffer_config_manager.set_total_epochs(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_train_batch_size(**kwargs)

trinity.manager.config_registry.buffer_config_manager.check_train_batch_size(unfinished_fields: set, *, key: str = 'train_batch_size')

trinity.manager.config_registry.buffer_config_manager.set_buffer_max_retry_times(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_max_retry_interval(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_taskset_path(**kwargs)

trinity.manager.config_registry.buffer_config_manager.check_taskset_path(unfinished_fields: set, *, key: str = 'taskset_path')

trinity.manager.config_registry.buffer_config_manager.set_taskset_args(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_eval_tasksets(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_default_workflow_type(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_default_reward_fn_type(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_system_prompt(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_reply_prefix(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_storage_type(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_experience_buffer_path(**kwargs)

trinity.manager.config_registry.buffer_config_manager.check_experience_buffer_path(unfinished_fields: set, *, key: str = 'experience_buffer_path')

trinity.manager.config_registry.buffer_config_manager.set_dpo_dataset_kwargs(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_sft_warmup_dataset_path(**kwargs)

trinity.manager.config_registry.buffer_config_manager.check_sft_warmup_dataset_path(unfinished_fields: set, *, key: str = 'sft_warmup_dataset_path')

trinity.manager.config_registry.buffer_config_manager.set_sft_warmup_dataset_args(**kwargs)

trinity.manager.config_registry.buffer_config_manager.set_sft_warmup_steps(**kwargs)

trinity.manager.config_registry.config_registry module

class trinity.manager.config_registry.config_registry.ConfigRegistry(name: str)[source]

Bases: Registry

A registry for managing configuration settings and their associated functions.

__init__(name: str)[source]

Initialization method.

Parameters:: name – a registry repo name

set_unfinished_fields(unfinished_fields: set)[source]

Set the unfinished fields to track incomplete configurations.

Parameters:: unfinished_fields (set) – Set of field names that are not yet configured.

property default_config: dict: Get the dictionary of default configuration values.

get(config_name: str)[source]

Retrieve a configuration function if its visible is met (if any).

Parameters:: config_name (str) – Name of the configuration to retrieve.
Returns:: The configuration function if visibles are met, else None.

get_check_func(config_name: str)[source]

Get the check function associated with a configuration.

Parameters:: config_name (str) – Name of the configuration.
Returns:: The check function for the specified configuration.

get_configs(*config_names: str, columns_spec: List[int] | None = None)[source]

Retrieve and display multiple configurations in Streamlit columns.

Parameters:

*config_names (str) – Names of configurations to retrieve.
columns_spec (List[int], optional) – Configuration for Streamlit columns.

register_config(default_value: Any | None = None, config_func: Callable[[None], None] | None = None, visible: Callable[[], bool] | None = None, other_configs: Dict[str, Any] | None = None)[source]

Decorator to register a configuration function.

The function name must start with ‘set_’, and the part after ‘set_’ becomes the config name.

Note: This function will automatically pass key=config_name as an argument to the registered configuration function. Ensure your function accepts this keyword argument.

Parameters:

default_value (Any, optional) – Default value for the configuration.
config_func (Callable, optional) – The configuration function to register.
visible (Callable, optional) – visible for when the config should be visible.
other_configs (Dict[str, Any], optional) – Additional configurations to register.

Returns:

A decorator function if config_func is None, else the registered config function.

register_check(check_func: Callable[[Set, str], None] | None = None)[source]

Decorator to register a check function for a configuration.

The function name must start with ‘check_’, and the part after ‘check_’ should match a config name.

Note: This function will automatically pass key=config_name and unfinished_fields=self.unfinished_fields as an argument to the registered check function. Ensure your function accepts these keyword arguments.

Parameters:: check_func (Callable, optional) – The check function to register.
Returns:: A decorator function if check_func is None, else the registered check function.

trinity.manager.config_registry.explorer_config_manager module

trinity.manager.config_registry.explorer_config_manager.explorer_visible() → bool[source]

trinity.manager.config_registry.explorer_config_manager.set_runner_num(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_max_timeout(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_explorer_max_retry_times(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_eval_interval(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_eval_on_latest_checkpoint(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_engine_type(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_engine_num(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_tensor_parallel_size(**kwargs)

trinity.manager.config_registry.explorer_config_manager.check_tensor_parallel_size(unfinished_fields: set, *, key: str = 'tensor_parallel_size')

trinity.manager.config_registry.explorer_config_manager.set_use_v1(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_enforce_eager(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_enable_prefix_caching(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_enable_chunked_prefill(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_gpu_memory_utilization(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_dtype(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_seed(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_enable_thinking(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_enable_openai_api(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_auxiliary_models(**kwargs)

trinity.manager.config_registry.explorer_config_manager.check_auxiliary_models(unfinished_fields: set, *, key: str = 'auxiliary_models')

trinity.manager.config_registry.explorer_config_manager.set_sync_method(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_sync_interval(**kwargs)

trinity.manager.config_registry.explorer_config_manager.set_sync_timeout(**kwargs)

trinity.manager.config_registry.model_config_manager module

trinity.manager.config_registry.model_config_manager.set_total_gpu_num()[source]

trinity.manager.config_registry.model_config_manager.set_trainer_gpu_num()[source]

trinity.manager.config_registry.model_config_manager.set_project(**kwargs)

trinity.manager.config_registry.model_config_manager.set_exp_name(**kwargs)

trinity.manager.config_registry.model_config_manager.set_checkpoint_root_dir(**kwargs)

trinity.manager.config_registry.model_config_manager.check_checkpoint_root_dir(unfinished_fields: set, *, key: str = 'checkpoint_root_dir')

trinity.manager.config_registry.model_config_manager.set_monitor_type(**kwargs)

trinity.manager.config_registry.model_config_manager.set_algorithm_type(**kwargs)

trinity.manager.config_registry.model_config_manager.set_repeat_times(**kwargs)

trinity.manager.config_registry.model_config_manager.set_gamma(**kwargs)

trinity.manager.config_registry.model_config_manager.set_lam(**kwargs)

trinity.manager.config_registry.model_config_manager.set_model_path(**kwargs)

trinity.manager.config_registry.model_config_manager.check_model_path(unfinished_fields: set, *, key: str = 'model_path')

trinity.manager.config_registry.model_config_manager.set_critic_model_path(**kwargs)

trinity.manager.config_registry.model_config_manager.set_max_prompt_tokens(**kwargs)

trinity.manager.config_registry.model_config_manager.set_max_response_tokens(**kwargs)

trinity.manager.config_registry.model_config_manager.set_node_num(**kwargs)

trinity.manager.config_registry.model_config_manager.set_gpu_per_node(**kwargs)

trinity.manager.config_registry.trainer_config_manager module

trinity.manager.config_registry.trainer_config_manager.use_critic()[source]

trinity.manager.config_registry.trainer_config_manager.set_trainer_type(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_save_interval(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_enable_preview(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_use_kl_loss(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_kl_loss_coef(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_entropy_coef(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_grad_clip(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_clip_ratio(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_training_args(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_ppo_epochs(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_training_strategy(**kwargs)

trinity.manager.config_registry.trainer_config_manager.use_fsdp()[source]

trinity.manager.config_registry.trainer_config_manager.set_param_offload(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_optimizer_offload(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_resume_mode(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_resume_from_path(**kwargs)

trinity.manager.config_registry.trainer_config_manager.check_resume_from_path(unfinished_fields: set, *, key: str = 'resume_from_path')

trinity.manager.config_registry.trainer_config_manager.set_critic_warmup(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_total_training_steps(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_default_hdfs_dir(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_remove_previous_ckpt_in_save(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_del_local_ckpt_after_load(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_max_actor_ckpt_to_keep(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_max_critic_ckpt_to_keep(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_norm_adv_by_std_in_grpo(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_use_kl_in_reward(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_kl_penalty(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_kl_ctrl_type(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_kl_ctrl_coef(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_horizon(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_target_kl(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_ppo_micro_batch_size_per_gpu(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_ref_log_prob_micro_batch_size_per_gpu(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_ulysses_sequence_parallel_size(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_lr(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_warmup_style(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_lr_warmup_steps_ratio(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_tau(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_opmd_baseline(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_use_uid(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_kl_loss_type(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_actor_checkpoint(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_lr(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_warmup_style(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_lr_warmup_steps_ratio(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_grad_clip(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_cliprange_value(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_ppo_micro_batch_size_per_gpu(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_ulysses_sequence_parallel_size(**kwargs)

trinity.manager.config_registry.trainer_config_manager.set_critic_checkpoint(**kwargs)