Static configuration of various entities participating in a Cogment application. This human-readable file is transformed by the cogment generate command into a language specific module.

Properties

actor_classes

actor_classes: CogmentYamlActorClass[]

Static configuration of actor classes available for participation in a trial.

Defined in: cogment/types/CogmentYaml.ts:133


commands

commands: Record<string, string>

List of arbitrary shell commands available for invocation through cogment run xyz

Defined in: cogment/types/CogmentYaml.ts:138


datalog

Optional datalog: CogmentYamlDatalog

Datalog static configuration.

Defined in: cogment/types/CogmentYaml.ts:142


environment

environment: object

Environment static configuration.

Type declaration:

Name Type Description
config_type string Full protobuf message type representing an environment's configuration.

Defined in: cogment/types/CogmentYaml.ts:146


import

import: object

User generated imports.

Type declaration:

Name Type Description
proto string[] List of paths to .proto files used by application specific entities.

Defined in: cogment/types/CogmentYaml.ts:155


pre_hooks

Optional pre_hooks: string[]

List of gRPC endpoints that are called in order prior to starting a trial. Pre-hooks act as a pipeline for mutating a trial's configuration before it's start. Pre-hooks may additionally be used for other purposes.

Defined in: cogment/types/CogmentYaml.ts:165


trial

trial: object

Trial static configuration.

Type declaration:

Name Type Description
config_type string Full protobuf message type representing a trial's configuration.

Defined in: cogment/types/CogmentYaml.ts:169


trial_params

trial_params: CogmentYamlTrialParameters

Trial specific configuration such as the actor slots available for registration, configuration for entities (eg: values for an environment's configuration).

Defined in: cogment/types/CogmentYaml.ts:179