nrel.hive.dispatcher.instruction_generator.instruction_function
Module Contents
Classes
A class that wraps an instruction function as an instruction generator |
Functions
A helper function to wrap an instruction function as an instruction generator |
Attributes
- nrel.hive.dispatcher.instruction_generator.instruction_function.InstructionFunction
- class nrel.hive.dispatcher.instruction_generator.instruction_function.AnonGenerator(instruction_function: InstructionFunction)[source]
Bases:
nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGeneratorA class that wraps an instruction function as an instruction generator
- property name: str
Defacto ID for any instruction generator is the class name
- generate_instructions(simulation_state: nrel.hive.state.simulation_state.simulation_state.SimulationState, environment: nrel.hive.runner.environment.Environment) Tuple[nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator, Tuple[nrel.hive.dispatcher.instruction.instruction.Instruction, Ellipsis]][source]
generates vehicle instructions which can perform vehicle state transitions based on some objective
- Parameters:
simulation_state – the current simulation state
environment – the simulation environment
- Returns:
the updated InstructionGenerator along with generated instructions
- nrel.hive.dispatcher.instruction_generator.instruction_function.instruction_generator_from_function(ig_or_if: InstructionFunction | nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator) nrel.hive.dispatcher.instruction_generator.instruction_generator.InstructionGenerator[source]
A helper function to wrap an instruction function as an instruction generator