schola.scripts

Full path: schola.scripts

schola.scripts

Sample scripts for running Reinforcement Learning with Schola.

Modules

Item	Description
common	Common utility functions and classes for use in Schola scripts.
launch	—
panel	Lightweight panel printing utilities for CLI scripts.
rllib	Scripts for training with Ray and RLlib.
sb3	Scripts for training with Stable Baselines 3.
utils	This package contains utility scripts for working with Schola (e.g. Building Protobuf files and disabling warnings etc.).

• schola.scripts.common

• schola.scripts.common.get_activation_function

• get_activation_function()

• schola.scripts.common.ActivationFunctionEnum

• ActivationFunctionEnum

• ActivationFunctionEnum.ReLU

• ActivationFunctionEnum.Sigmoid

• ActivationFunctionEnum.TanH

• schola.scripts.common.CheckpointArgs

• CheckpointArgs

• CheckpointArgs.init()

• CheckpointArgs.checkpoint_dir

• CheckpointArgs.enable_checkpoints

• CheckpointArgs.export_onnx

• CheckpointArgs.name_prefix_override

• CheckpointArgs.save_final_policy

• CheckpointArgs.save_freq

• schola.scripts.common.EnvironmentArgs

• EnvironmentArgs

• EnvironmentArgs.init()

• EnvironmentArgs.protocol

• EnvironmentArgs.simulator

• schola.scripts.common.RLLibLauncherExtension

• RLLibLauncherExtension

• RLLibLauncherExtension.init()

• RLLibLauncherExtension.get_extra_callbacks()

• schola.scripts.common.Sb3LauncherExtension

• Sb3LauncherExtension

• Sb3LauncherExtension.init()

• Sb3LauncherExtension.get_extra_KVWriters()

• Sb3LauncherExtension.get_extra_callbacks()

• schola.scripts.common.UnrealEditorSimulatorArgs

• UnrealEditorSimulatorArgs

• UnrealEditorSimulatorArgs.init()

• UnrealEditorSimulatorArgs.make()

• schola.scripts.common.UnrealExecutableCommandLinePlaceholder

• UnrealExecutableCommandLinePlaceholder

• UnrealExecutableCommandLinePlaceholder.init()

• UnrealExecutableCommandLinePlaceholder.executable_path

• UnrealExecutableCommandLinePlaceholder.make()

• schola.scripts.common.UnrealExecutableSimulatorArgs

• UnrealExecutableSimulatorArgs

• UnrealExecutableSimulatorArgs.init()

• UnrealExecutableSimulatorArgs.disable_script

• UnrealExecutableSimulatorArgs.display_logs

• UnrealExecutableSimulatorArgs.executable_path

• UnrealExecutableSimulatorArgs.fps

• UnrealExecutableSimulatorArgs.headless

• UnrealExecutableSimulatorArgs.make()

• UnrealExecutableSimulatorArgs.map

• schola.scripts.common.gRPCProtocolArgs

• gRPCProtocolArgs

• gRPCProtocolArgs.init()

• gRPCProtocolArgs.environment_start_timeout

• gRPCProtocolArgs.make()

• gRPCProtocolArgs.port

• gRPCProtocolArgs.url

• schola.scripts.launch

• schola.scripts.launch.main

• main()

• schola.scripts.panel

• schola.scripts.panel.print_error

• print_error()

• schola.scripts.panel.print_info

• print_info()

• schola.scripts.panel.print_panel

• print_panel()

• schola.scripts.panel.print_warning

• print_warning()

• schola.scripts.rllib

• schola.scripts.rllib.launch_imitation

• schola.scripts.rllib.launch_imitation.bc

• bc()

• schola.scripts.rllib.launch_imitation.main

• main()

• schola.scripts.rllib.launch_imitation.BCScriptArgs

• BCScriptArgs

• BCScriptArgs.init()

• BCScriptArgs.behaviour_cloning_settings

• BCScriptArgs.checkpoint_settings

• BCScriptArgs.environment_settings

• BCScriptArgs.logging_settings

• BCScriptArgs.network_architecture_settings

• BCScriptArgs.resource_settings

• BCScriptArgs.resume_settings

• BCScriptArgs.training_settings

• schola.scripts.rllib.launch_imitation.BehaviourCloningSettings

• BehaviourCloningSettings

• BehaviourCloningSettings.init()

• BehaviourCloningSettings.cloning_steps

• BehaviourCloningSettings.converted_expert_path

• BehaviourCloningSettings.expert_path

• BehaviourCloningSettings.name

• schola.scripts.rllib.rllib_to_onnx

• schola.scripts.rllib.rllib_to_onnx.export

• export()

• schola.scripts.rllib.settings

• schola.scripts.rllib.settings.APPOSettings

• APPOSettings

• APPOSettings.init()

• APPOSettings.get_settings_dict()

• APPOSettings.name

• APPOSettings.rllib_config

• schola.scripts.rllib.settings.IMPALASettings

• IMPALASettings

• IMPALASettings.init()

• IMPALASettings.get_settings_dict()

• IMPALASettings.name

• IMPALASettings.rllib_config

• IMPALASettings.vtrace

• IMPALASettings.vtrace_clip_pg_rho_threshold

• IMPALASettings.vtrace_clip_rho_threshold

• schola.scripts.rllib.settings.LoggingSettings

• LoggingSettings

• LoggingSettings.init()

• LoggingSettings.name

• LoggingSettings.rllib_verbosity

• LoggingSettings.schola_verbosity

• schola.scripts.rllib.settings.NetworkArchitectureSettings

• NetworkArchitectureSettings

• NetworkArchitectureSettings.init()

• NetworkArchitectureSettings.activation

• NetworkArchitectureSettings.attention_dim

• NetworkArchitectureSettings.fcnet_hiddens

• NetworkArchitectureSettings.name

• NetworkArchitectureSettings.use_attention

• schola.scripts.rllib.settings.PPOSettings

• PPOSettings

• PPOSettings.init()

• PPOSettings.clip_param

• PPOSettings.gae_lambda

• PPOSettings.get_settings_dict()

• PPOSettings.name

• PPOSettings.rllib_config

• PPOSettings.use_gae

• schola.scripts.rllib.settings.RLLibAlgorithmSpecificSettings

• RLLibAlgorithmSpecificSettings

• RLLibAlgorithmSpecificSettings.get_parser()

• RLLibAlgorithmSpecificSettings.get_settings_dict()

• schola.scripts.rllib.settings.RLlibScriptArgs

• RLlibScriptArgs

• RLlibScriptArgs.init()

• RLlibScriptArgs.algorithm_settings

• RLlibScriptArgs.checkpoint_settings

• RLlibScriptArgs.environment_settings

• RLlibScriptArgs.logging_settings

• RLlibScriptArgs.network_architecture_settings

• RLlibScriptArgs.resource_settings

• RLlibScriptArgs.resume_settings

• RLlibScriptArgs.training_settings

• schola.scripts.rllib.settings.ResourceSettings

• ResourceSettings

• ResourceSettings.init()

• ResourceSettings.name

• ResourceSettings.num_cpus

• ResourceSettings.num_cpus_for_main_process

• ResourceSettings.num_cpus_per_learner

• ResourceSettings.num_gpus

• ResourceSettings.num_gpus_per_learner

• ResourceSettings.num_learners

• ResourceSettings.using_cluster

• schola.scripts.rllib.settings.ResumeSettings

• ResumeSettings

• ResumeSettings.init()

• ResumeSettings.name

• ResumeSettings.resume_from

• schola.scripts.rllib.settings.SACSettings

• SACSettings

• SACSettings.init()

• SACSettings.get_settings_dict()

• SACSettings.initial_alpha

• SACSettings.n_step

• SACSettings.name

• SACSettings.rllib_config

• SACSettings.target_entropy

• SACSettings.tau

• SACSettings.twin_q

• schola.scripts.rllib.settings.TrainingSettings

• TrainingSettings

• TrainingSettings.init()

• TrainingSettings.gamma

• TrainingSettings.learning_rate

• TrainingSettings.minibatch_size

• TrainingSettings.name

• TrainingSettings.num_sgd_iter

• TrainingSettings.timesteps

• TrainingSettings.train_batch_size_per_learner

• schola.scripts.rllib.train

• schola.scripts.rllib.train.debug_main_from_cli

• debug_main_from_cli()

• schola.scripts.rllib.train.impala

• impala()

• schola.scripts.rllib.train.main

• main()

• schola.scripts.rllib.train.ppo

• ppo()

• schola.scripts.rllib.train.sac

• sac()

• schola.scripts.sb3

• schola.scripts.sb3.sb3_to_onnx

• schola.scripts.sb3.sb3_to_onnx.export

• export()

• schola.scripts.sb3.settings

• schola.scripts.sb3.settings.BaseSb3AlgorithmArgs

• BaseSb3AlgorithmArgs

• BaseSb3AlgorithmArgs.init()

• BaseSb3AlgorithmArgs.batch_size

• BaseSb3AlgorithmArgs.learning_rate

• BaseSb3AlgorithmArgs.n_steps

• schola.scripts.sb3.settings.PPOSettings

• PPOSettings

• PPOSettings.init()

• PPOSettings.clip_range

• PPOSettings.constructor

• PPOSettings.critic_type

• PPOSettings.ent_coef

• PPOSettings.gae_lambda

• PPOSettings.gamma

• PPOSettings.max_grad_norm

• PPOSettings.n_epochs

• PPOSettings.name

• PPOSettings.normalize_advantage

• PPOSettings.sde_sample_freq

• PPOSettings.use_sde

• PPOSettings.vf_coef

• schola.scripts.sb3.settings.SACSettings

• SACSettings

• SACSettings.init()

• SACSettings.batch_size

• SACSettings.buffer_size

• SACSettings.constructor

• SACSettings.critic_type

• SACSettings.ent_coef

• SACSettings.gamma

• SACSettings.gradient_steps

• SACSettings.learning_rate

• SACSettings.learning_starts

• SACSettings.name

• SACSettings.optimize_memory_usage

• SACSettings.replay_buffer_kwargs

• SACSettings.sde_sample_freq

• SACSettings.target_entropy

• SACSettings.target_update_interval

• SACSettings.tau

• SACSettings.train_freq

• SACSettings.use_sde

• schola.scripts.sb3.settings.SB3ScriptArgs

• SB3ScriptArgs

• SB3ScriptArgs.init()

• SB3ScriptArgs.algorithm_settings

• SB3ScriptArgs.checkpoint_settings

• SB3ScriptArgs.disable_eval

• SB3ScriptArgs.environment_settings

• SB3ScriptArgs.logging_settings

• SB3ScriptArgs.name_prefix

• SB3ScriptArgs.network_architecture_settings

• SB3ScriptArgs.pbar

• SB3ScriptArgs.resume_settings

• SB3ScriptArgs.timesteps

• schola.scripts.sb3.settings.Sb3CheckpointArgs

• Sb3CheckpointArgs

• Sb3CheckpointArgs.init()

• Sb3CheckpointArgs.save_replay_buffer

• Sb3CheckpointArgs.save_vecnormalize

• schola.scripts.sb3.settings.Sb3LoggingArgs

• Sb3LoggingArgs

• Sb3LoggingArgs.init()

• Sb3LoggingArgs.callback_verbosity

• Sb3LoggingArgs.enable_tensorboard

• Sb3LoggingArgs.log_dir

• Sb3LoggingArgs.log_freq

• Sb3LoggingArgs.sb3_verbosity

• Sb3LoggingArgs.schola_verbosity

• schola.scripts.sb3.settings.Sb3NetworkArchitectureArgs

• Sb3NetworkArchitectureArgs

• Sb3NetworkArchitectureArgs.init()

• Sb3NetworkArchitectureArgs.activation

• Sb3NetworkArchitectureArgs.critic_parameters

• Sb3NetworkArchitectureArgs.policy_parameters

• schola.scripts.sb3.settings.Sb3ResumeArgs

• Sb3ResumeArgs

• Sb3ResumeArgs.init()

• Sb3ResumeArgs.load_replay_buffer

• Sb3ResumeArgs.load_vecnormalize

• Sb3ResumeArgs.reset_timestep

• Sb3ResumeArgs.resume_from

• schola.scripts.sb3.train

• schola.scripts.sb3.train.main

• main()

• schola.scripts.sb3.train.ppo

• ppo()

• schola.scripts.sb3.train.sac

• sac()

• schola.scripts.sb3.train.warn_if_small_image_observation

• warn_if_small_image_observation()

• schola.scripts.sb3.utils

• schola.scripts.sb3.utils.CustomProgressBarCallback

• CustomProgressBarCallback

• CustomProgressBarCallback.init()

• CustomProgressBarCallback.pbar

• schola.scripts.sb3.utils.RewardCallback

• RewardCallback

• RewardCallback.num_envs

• RewardCallback.callbacks

• RewardCallback.summarize_every

• RewardCallback.curr_logging_interval

• RewardCallback.start_time

• RewardCallback.init()

• RewardCallback.ready_to_log

• schola.scripts.sb3.utils.SingleEnvRewardCallback

• SingleEnvRewardCallback

• SingleEnvRewardCallback.episode_reward

• SingleEnvRewardCallback.episode_rewards

• SingleEnvRewardCallback.episode_steps

• SingleEnvRewardCallback.step_count

• SingleEnvRewardCallback.last_logging_interval

• SingleEnvRewardCallback.logging_interval_size

• SingleEnvRewardCallback.id

• SingleEnvRewardCallback.init()

• SingleEnvRewardCallback.get_reward_interval()

• SingleEnvRewardCallback.get_step_interval()

• SingleEnvRewardCallback.increment_logging_interval()

• SingleEnvRewardCallback.ready_to_log

• schola.scripts.utils

• schola.scripts.utils.build_docs

• schola.scripts.utils.build_docs.main

• main()

• schola.scripts.utils.build_plugin

• schola.scripts.utils.build_plugin.find_uplugin

• find_uplugin()

• schola.scripts.utils.build_plugin.main

• main()

• schola.scripts.utils.compile_proto

• schola.scripts.utils.compile_proto.add_api_macro

• add_api_macro()

• schola.scripts.utils.compile_proto.default_warnings

• default_warnings()

• schola.scripts.utils.compile_proto.disable_warnings

• disable_warnings()

• schola.scripts.utils.compile_proto.fix_imports

• fix_imports()

• schola.scripts.utils.compile_proto.get_files

• get_files()

• schola.scripts.utils.compile_proto.get_generated_cpp_file_types

• get_generated_cpp_file_types()

• schola.scripts.utils.compile_proto.get_generated_python_file_types

• get_generated_python_file_types()

• schola.scripts.utils.compile_proto.get_proto_files

• get_proto_files()

• schola.scripts.utils.compile_proto.main

• main()

• schola.scripts.utils.compile_proto.make_grpc_files

• make_grpc_files()

• schola.scripts.utils.compile_proto.make_proto_files

• make_proto_files()

• schola.scripts.utils.compile_proto.move_files

• move_files()