Index

_

__call__() (cernml.coi.configurable.StrSafeBool method) __dir__() (cernml.coi._machinery.AttrCheckProtocolMeta method) __init__() (cernml.coi._machinery.AttrCheckProtocol method) (cernml.coi._machinery.AttrCheckProtocolMeta method) __init_subclass__() (cernml.coi._machinery.AttrCheckProtocol class method) __instancecheck__() (cernml.coi._machinery.AttrCheckProtocolMeta method) (typing._ProtocolMeta method) __new__() (cernml.coi._machinery.AttrCheckProtocolMeta static method) (typing._ProtocolMeta static method) __non_callable_proto_members__ (cernml.coi._machinery.AttrCheckProtocol attribute) __proto_classmethods__ (cernml.coi._machinery.AttrCheckProtocol attribute)

__protocol_attrs__ (cernml.coi._machinery.AttrCheckProtocol attribute) __subclasscheck__() (cernml.coi._machinery.AttrCheckProtocolMeta method) (typing._ProtocolMeta method) __subclasshook__() (cernml.coi._machinery.AttrCheckProtocol class method) _AlwaysContainsProtocol (class in cernml.coi._machinery) _get_dunder_dict_of_class() (in module cernml.coi._machinery) _GetAttr() (in module cernml.coi._machinery) _is_protocol (cernml.coi._machinery.AttrCheckProtocol attribute) _is_runtime_protocol (cernml.coi._machinery.AttrCheckProtocol attribute) _ProtocolMeta (class in typing) _SPECIAL_NAMES (in module cernml.coi._machinery) _static_mro() (in module cernml.coi._machinery)

A

achieved_goal (cernml.coi.GoalObs attribute) ActType (in module cernml.coi) AD (cernml.coi.Machine attribute) add() (cernml.coi.Config method) all() (cernml.coi.registration.EnvRegistry method) AmbiguousNamespaceWarning AnyBool (in module cernml.coi.configurable)

AnyOptimizable (in module cernml.coi) ApiCompatError apply_config() (cernml.coi.Configurable method) attr_in_annotations() (in module cernml.coi._machinery) AttrCheckProtocol (class in cernml.coi._machinery) AttrCheckProtocolMeta (class in cernml.coi._machinery) attrs_match() (in module cernml.coi._machinery) AWAKE (cernml.coi.Machine attribute)

B

BadConfig

C

can_be_cancelled (cernml.coi.cancellation.Token property) can_reset_cancellation (cernml.coi.cancellation.TokenSource property) cancel() (cernml.coi.cancellation.TokenSource method) cancellation_requested (cernml.coi.cancellation.Token property) (cernml.coi.cancellation.TokenSource property) CancelledError CannotReset cernml.coi module cernml.coi._classes module cernml.coi._custom_optimizer_provider module cernml.coi._custom_policy_provider module cernml.coi._goalenv module cernml.coi._intersections module cernml.coi._machine module cernml.coi._machinery module cernml.coi._sepenv module cernml.coi._typeguards module cernml.coi.cancellation module cernml.coi.checkers module cernml.coi.configurable module cernml.coi.protocols module cernml.coi.register_envs() (in module cernml.coi)

cernml.coi.registration module cernml.coi.registration.errors module check() (in module cernml.coi) check_configurable() (in module cernml.coi.checkers) check_env() (in module cernml.coi.checkers) check_function_optimizable() (in module cernml.coi.checkers) check_problem() (in module cernml.coi.checkers) check_single_optimizable() (in module cernml.coi.checkers) close() (cernml.coi.Problem method) (cernml.coi.protocols.Problem method) complete_cancellation() (cernml.coi.cancellation.Token method) compute_function_objective() (cernml.coi.FunctionOptimizable method) (cernml.coi.protocols.FunctionOptimizable method) compute_observation() (cernml.coi.SeparableEnv method) (cernml.coi.SeparableGoalEnv method) compute_reward() (cernml.coi.SeparableEnv method) compute_single_objective() (cernml.coi.protocols.SingleOptimizable method) (cernml.coi.SingleOptimizable method) compute_terminated() (cernml.coi.SeparableEnv method) compute_truncated() (cernml.coi.SeparableEnv method) Config (class in cernml.coi) Configurable (class in cernml.coi) ConfigValues (in module cernml.coi) Constraint (in module cernml.coi) (in module cernml.coi.protocols) constraint_names (cernml.coi.protocols.SingleOptimizable attribute) (cernml.coi.SingleOptimizable attribute) constraints (cernml.coi.FunctionOptimizable attribute) (cernml.coi.protocols.FunctionOptimizable attribute) (cernml.coi.protocols.SingleOptimizable attribute) (cernml.coi.SingleOptimizable attribute) current_namespace (cernml.coi.registration.EnvRegistry property) CustomOptimizerProvider (class in cernml.coi) CustomPolicyProvider (class in cernml.coi)

D

deduce_type() (in module cernml.coi.configurable) DeprecatedEnv

desired_goal (cernml.coi.GoalObs attribute) downcast_spec() (in module cernml.coi.registration) DuplicateConfig

E

ELENA (cernml.coi.Machine attribute) entry point cernml.checkers cernml.custom_optimizers cernml.custom_policies cernml.envs EntryPointError Env (class in cernml.coi) (class in cernml.coi.protocols)

EnvImportError EnvOutOfDateWarning EnvRegistry (class in cernml.coi.registration) EnvSpec (class in cernml.coi.registration) EnvSpecExistsWarning EnvUpgradedWarning extend() (cernml.coi.Config method)

F

Field (class in cernml.coi.Config) fields() (cernml.coi.Config method) find_mismatched_attr() (in module cernml.coi._machinery)

from_json() (cernml.coi.registration.EnvSpec class method) FunctionOptimizable (class in cernml.coi) (class in cernml.coi.protocols)

G

get_class_annotations() (in module cernml.coi._machinery) get_class_annotations_impl() (in module cernml.coi._machinery) get_config() (cernml.coi.Configurable method) get_field_values() (cernml.coi.Config method) get_initial_params() (cernml.coi.FunctionOptimizable method) (cernml.coi.protocols.FunctionOptimizable method) (cernml.coi.protocols.SingleOptimizable method) (cernml.coi.SingleOptimizable method) get_objective_function_name() (cernml.coi.FunctionOptimizable method) (cernml.coi.protocols.FunctionOptimizable method) get_optimization_space() (cernml.coi.FunctionOptimizable method) (cernml.coi.protocols.FunctionOptimizable method)

get_optimizers() (cernml.coi.CustomOptimizerProvider class method) get_param_function_names() (cernml.coi.FunctionOptimizable method) (cernml.coi.protocols.FunctionOptimizable method) get_policy_names() (cernml.coi.CustomPolicyProvider class method) get_wrapper_attr() (cernml.coi.Problem method) (cernml.coi.protocols.Problem method) GoalEnv (class in cernml.coi) GoalObs (class in cernml.coi) GoalType (in module cernml.coi) GymDeprecationWarning gymnasium.envs.registration.EnvCreator() (in module cernml.coi.registration) gymnasium.envs.registration.VectorEnvCreator() (in module cernml.coi.registration)

H

HasNpRandom (class in cernml.coi) (class in cernml.coi.protocols)

HumanRenderingError HumanRenderingWarning

I

info dict key "episode" "final_info" "final_observation" "reward" "success" InfoDict (in module cernml.coi) (in module cernml.coi.protocols) is_configurable() (in module cernml.coi) is_configurable_class() (in module cernml.coi) is_custom_optimizer_provider() (in module cernml.coi) is_custom_optimizer_provider_class() (in module cernml.coi) is_env() (in module cernml.coi) is_env_class() (in module cernml.coi) is_function_optimizable() (in module cernml.coi)

is_function_optimizable_class() (in module cernml.coi) is_goal_env() (in module cernml.coi) is_goal_env_class() (in module cernml.coi) is_optimizable() (in module cernml.coi) is_optimizable_class() (in module cernml.coi) is_problem() (in module cernml.coi) is_problem_class() (in module cernml.coi) is_protocol() (in module cernml.coi._machinery) is_separable_env() (in module cernml.coi) is_separable_env_class() (in module cernml.coi) is_separable_goal_env() (in module cernml.coi) is_separable_goal_env_class() (in module cernml.coi) is_single_optimizable() (in module cernml.coi) is_single_optimizable_class() (in module cernml.coi) ISOLDE (cernml.coi.Machine attribute)

L

lazy_load_getattr_static() (in module cernml.coi._machinery) LEIR (cernml.coi.Machine attribute) LHC (cernml.coi.Machine attribute)

LINAC_2 (cernml.coi.Machine attribute) LINAC_3 (cernml.coi.Machine attribute) LINAC_4 (cernml.coi.Machine attribute) load_policy() (cernml.coi.CustomPolicyProvider method)

M

Machine (class in cernml.coi) make() (cernml.coi.registration.EnvRegistry method) (cernml.coi.registration.EnvSpec method) (in module cernml.coi) make_vec() (cernml.coi.registration.EnvRegistry method) (in module cernml.coi) (in module gymnasium) metadata (cernml.coi.Problem attribute) (cernml.coi.protocols.Problem attribute) metadata key "cern.cancellable" "cern.japc" "cern.machine" "render_fps" "render_modes" MinimalEnvSpec (class in cernml.coi.registration) MISSING (in module cernml.coi.registration._sentinel)

module cernml.coi cernml.coi._classes cernml.coi._custom_optimizer_provider cernml.coi._custom_policy_provider cernml.coi._goalenv cernml.coi._intersections cernml.coi._machine cernml.coi._machinery cernml.coi._sepenv cernml.coi._typeguards cernml.coi.cancellation cernml.coi.checkers cernml.coi.configurable cernml.coi.protocols cernml.coi.registration cernml.coi.registration.errors

N

NameNotFoundError namespace() (cernml.coi.registration.EnvRegistry method) NamespaceNotFoundError NO_MACHINE (cernml.coi.Machine attribute)

non_callable_proto_members() (in module cernml.coi._machinery) NotFoundError np_random (cernml.coi.HasNpRandom property) (cernml.coi.Problem property) (cernml.coi.protocols.HasNpRandom attribute)

O

objective_name (cernml.coi.protocols.SingleOptimizable attribute) (cernml.coi.SingleOptimizable attribute) observation (cernml.coi.GoalObs attribute) ObsType (in module cernml.coi) OptEnv (class in cernml.coi)

OptGoalEnv (class in cernml.coi) optimization_space (cernml.coi.protocols.SingleOptimizable attribute) (cernml.coi.SingleOptimizable attribute) override_skeleton_points() (cernml.coi.FunctionOptimizable method) (cernml.coi.protocols.FunctionOptimizable method)

P

param_names (cernml.coi.protocols.SingleOptimizable attribute) (cernml.coi.SingleOptimizable attribute) ParamType (in module cernml.coi) (in module cernml.coi.protocols) PluginWarning Policy (class in cernml.coi) pprint() (cernml.coi.registration.EnvRegistry method) (cernml.coi.registration.EnvSpec method) (cernml.coi.registration.MinimalEnvSpec method) pprint_registry() (in module cernml.coi) predict() (cernml.coi.Policy method) Problem (class in cernml.coi) (class in cernml.coi.protocols)

proto_classmethods() (in module cernml.coi._machinery) protocol_attrs() (in module cernml.coi._machinery) PS (cernml.coi.Machine attribute) PSB (cernml.coi.Machine attribute) Python Enhancement Proposals PEP 345 PEP 396#pep-rejection PEP 440#version-specifiers PEP 483 PEP 484#support-for-singleton-types-in-unions PEP 661#specification

R

raise_if_cancellation_requested() (cernml.coi.cancellation.Token method) register() (cernml.coi.registration.EnvRegistry method) (in module cernml.coi) RegistrationError registry (in module cernml.coi) RegistryError RegistryWarning render mode "ansi" "ansi_list" "human" "matplotlib_figures" "rgb_array" "rgb_array_list" None

render() (cernml.coi.Problem method) (cernml.coi.protocols.Problem method) render_mode (cernml.coi.Problem attribute) (cernml.coi.protocols.FunctionOptimizable attribute) (cernml.coi.protocols.Problem property) (cernml.coi.protocols.SingleOptimizable attribute) RenderModeWarning reset_cancellation() (cernml.coi.cancellation.TokenSource method)

S

Sentinel (class in cernml.coi.registration._sentinel) SeparableEnv (class in cernml.coi) SeparableGoalEnv (class in cernml.coi) SeparableOptEnv (class in cernml.coi) SeparableOptGoalEnv (class in cernml.coi) SingleOptimizable (class in cernml.coi) (class in cernml.coi.protocols) Space (class in cernml.coi)

spec (cernml.coi.Problem attribute) (cernml.coi.protocols.Problem property) spec() (cernml.coi.registration.EnvRegistry method) (in module cernml.coi) SPS (cernml.coi.Machine attribute) step() (cernml.coi.SeparableEnv method) (cernml.coi.SeparableGoalEnv method) StrSafeBool (class in cernml.coi.configurable)

T

to_json() (cernml.coi.registration.EnvSpec method) (cernml.coi.registration.MinimalEnvSpec method) token (cernml.coi.cancellation.TokenSource property)

Token (class in cernml.coi.cancellation) TokenSource (class in cernml.coi.cancellation) typing._get_protocol_attrs() (in module cernml.coi._machinery) typing._proto_hook (in module cernml.coi._machinery)

U

UnversionedExistsError

unwrapped (cernml.coi.Problem property) (cernml.coi.protocols.Problem property)

V

validate() (cernml.coi.Config method) (cernml.coi.Config.Field method)

validate_all() (cernml.coi.Config method) VersionedExistsError VersionNotFoundError

W

wait_handle (cernml.coi.cancellation.Token property) WrapperClassError WrapperError

WrapperMismatchError WrapperSpec (class in gymnasium.envs.registration) WrapperUnexpectedError