qgym
0.3.1

Contents:

  • qgym package
    • qgym.envs package
      • InitialMapping
        • InitialMapping.__init__()
        • InitialMapping.action_space
        • InitialMapping.metadata
        • InitialMapping.observation_space
        • InitialMapping.reset()
      • Routing
        • Routing.__init__()
        • Routing.reset()
      • Scheduling
        • Scheduling.__init__()
        • Scheduling.get_circuit()
        • Scheduling.reset()
      • qgym.envs.initial_mapping package
        • BasicRewarder
        • EpisodeRewarder
        • InitialMapping
        • InitialMappingState
        • SingleStepRewarder
        • qgym.envs.initial_mapping.initial_mapping module
        • qgym.envs.initial_mapping.initial_mapping_rewarders module
        • qgym.envs.initial_mapping.initial_mapping_state module
        • qgym.envs.initial_mapping.initial_mapping_visualiser module
      • qgym.envs.routing package
        • BasicRewarder
        • EpisodeRewarder
        • Routing
        • RoutingState
        • SwapQualityRewarder
        • qgym.envs.routing.routing module
        • qgym.envs.routing.routing_rewarders module
        • qgym.envs.routing.routing_state module
        • qgym.envs.routing.routing_visualiser module
      • qgym.envs.scheduling package
        • BasicRewarder
        • CommutationRulebook
        • EpisodeRewarder
        • MachineProperties
        • Scheduling
        • SchedulingState
        • qgym.envs.scheduling.machine_properties module
        • qgym.envs.scheduling.rulebook module
        • qgym.envs.scheduling.scheduling module
        • qgym.envs.scheduling.scheduling_dataclasses module
        • qgym.envs.scheduling.scheduling_rewarders module
        • qgym.envs.scheduling.scheduling_state module
        • qgym.envs.scheduling.scheduling_visualiser module
    • qgym.generators package
      • BasicCircuitGenerator
        • BasicCircuitGenerator.__init__()
        • BasicCircuitGenerator.__next__()
        • BasicCircuitGenerator.__repr__()
        • BasicCircuitGenerator.set_state_attributes()
      • BasicGraphGenerator
        • BasicGraphGenerator.__init__()
        • BasicGraphGenerator.__next__()
        • BasicGraphGenerator.__repr__()
        • BasicGraphGenerator.set_state_attributes()
      • BasicInteractionGenerator
        • BasicInteractionGenerator.__init__()
        • BasicInteractionGenerator.__next__()
        • BasicInteractionGenerator.__repr__()
        • BasicInteractionGenerator.set_state_attributes()
      • NullCircuitGenerator
        • NullCircuitGenerator.__init__()
        • NullCircuitGenerator.__next__()
        • NullCircuitGenerator.__repr__()
        • NullCircuitGenerator.set_state_attributes()
      • NullGraphGenerator
        • NullGraphGenerator.__init__()
        • NullGraphGenerator.__next__()
        • NullGraphGenerator.__repr__()
        • NullGraphGenerator.set_state_attributes()
      • NullInteractionGenerator
        • NullInteractionGenerator.__init__()
        • NullInteractionGenerator.__next__()
        • NullInteractionGenerator.__repr__()
        • NullInteractionGenerator.set_state_attributes()
      • WorkshopCircuitGenerator
        • WorkshopCircuitGenerator.__init__()
        • WorkshopCircuitGenerator.__next__()
        • WorkshopCircuitGenerator.__repr__()
        • WorkshopCircuitGenerator.set_state_attributes()
      • qgym.generators.circuit module
        • BasicCircuitGenerator
        • CircuitGenerator
        • NullCircuitGenerator
        • WorkshopCircuitGenerator
      • qgym.generators.graph module
        • BasicGraphGenerator
        • GraphGenerator
        • NullGraphGenerator
      • qgym.generators.interaction module
        • BasicInteractionGenerator
        • InteractionGenerator
        • NullInteractionGenerator
    • qgym.spaces package
      • Box
        • Box.__init__()
      • Dict
        • Dict.__init__()
      • Discrete
        • Discrete.__init__()
      • MultiBinary
        • MultiBinary.__init__()
      • MultiDiscrete
        • MultiDiscrete.__init__()
      • qgym.spaces.box module
        • Box
      • qgym.spaces.dict module
        • Dict
      • qgym.spaces.discrete module
        • Discrete
      • qgym.spaces.multi_binary module
        • MultiBinary
      • qgym.spaces.multi_discrete module
        • MultiDiscrete
    • qgym.templates package
      • Environment
        • Environment.action_space
        • Environment.close()
        • Environment.observation_space
        • Environment.render()
        • Environment.reset()
        • Environment.rewarder
        • Environment.rng
        • Environment.step()
      • Rewarder
        • Rewarder.__eq__()
        • Rewarder.compute_reward()
        • Rewarder.reward_range
      • State
        • State.create_observation_space()
        • State.is_done()
        • State.is_truncated()
        • State.obtain_info()
        • State.obtain_observation()
        • State.reset()
        • State.rng
        • State.seed()
        • State.steps_done
        • State.update_state()
      • Visualiser
        • Visualiser.close()
        • Visualiser.colors
        • Visualiser.font
        • Visualiser.is_open
        • Visualiser.render()
        • Visualiser.render_data
        • Visualiser.screen
        • Visualiser.screen_height
        • Visualiser.screen_width
        • Visualiser.step()
      • qgym.templates.environment module
        • Environment
      • qgym.templates.rewarder module
        • Rewarder
      • qgym.templates.state module
        • State
      • qgym.templates.visualiser module
        • RenderData
        • Visualiser
    • qgym.utils package
      • GateEncoder
        • GateEncoder.__init__()
        • GateEncoder.__repr__()
        • GateEncoder.decode_gates()
        • GateEncoder.encode_gates()
        • GateEncoder.learn_gates()
      • qgym.utils.visualisation package
        • qgym.utils.visualisation.colors module
        • qgym.utils.visualisation.typing module
        • qgym.utils.visualisation.wrappers module
      • qgym.utils.gate_encoder module
        • GateEncoder
      • qgym.utils.input_parsing module
        • has_fidelity()
        • parse_connection_graph()
        • parse_rewarder()
        • parse_seed()
        • parse_visualiser()
      • qgym.utils.input_validation module
        • check_adjacency_matrix()
        • check_bool()
        • check_graph_is_valid_topology()
        • check_instance()
        • check_int()
        • check_real()
        • check_string()
        • warn_if_negative()
        • warn_if_positive()
    • qgym.custom_types module
      • Gate
        • Gate.name
        • Gate.q1
        • Gate.q2
qgym
  • Search

© Copyright 2023, QuTech & TNO.

Built with Sphinx using a theme provided by Read the Docs.