syllabus package

Subpackages

• Global Synchronization
  • Basic Usage
• Examples
  • Subpackages
    • Example Models
      • Submodules
      • syllabus.examples.models.minigrid_model module
      • syllabus.examples.models.procgen_model module
    • Task Wrappers
      • CartPole Task Wrapper
      • Minigrid Task Wrapper
      • NetHack Task Wrapper
      • Pistonball Task Wrapper
      • Procgen Task Wrapper
      • SimpleTag Task Wrapper
    • Example Utils
      • Submodules
      • syllabus.examples.utils.vecenv module
      • syllabus.examples.utils.vtrace module
      • Module contents
• Task Spaces
  • Usage
    • Task Space
      • TaskSpace
    • Discrete Task Space
      • DiscreteTaskSpace
    • Box Task Space
      • BoxTaskSpace
    • MultiDiscrete Task Space
      • MultiDiscreteTaskSpace
    • Tuple Task Space
      • TupleTaskSpace
• syllabus.tests package
  • Submodules
  • syllabus.tests.determinism module
    • compare_episodes()
    • compare_episodes_gymnasium()
    • compare_episodes_pettingzoo()
    • compare_obs()
    • print_if_verbose()
    • test_determinism()
  • syllabus.tests.sync_test_curriculum module
    • SyncTestCurriculum
      • SyncTestCurriculum.REQUIRES_CENTRAL_UPDATES
      • SyncTestCurriculum.REQUIRES_STEP_UPDATES
      • SyncTestCurriculum.get_stats()
      • SyncTestCurriculum.requires_step_updates
      • SyncTestCurriculum.sample()
      • SyncTestCurriculum.update_on_episode()
      • SyncTestCurriculum.update_on_step()
      • SyncTestCurriculum.update_on_step_batch()
  • syllabus.tests.sync_test_env module
    • PettingZooSyncTestEnv
      • PettingZooSyncTestEnv.action_space()
      • PettingZooSyncTestEnv.reset()
      • PettingZooSyncTestEnv.step()
    • SyncTestEnv
      • SyncTestEnv.reset()
      • SyncTestEnv.step()
  • syllabus.tests.utils module
    • ExtractDictObservation
      • ExtractDictObservation.observation()
      • ExtractDictObservation.reset()
    • create_cartpole_env()
    • create_gymnasium_synctest_env()
    • create_minigrid_env()
    • create_nethack_env()
    • create_pettingzoo_synctest_env()
    • create_pistonball_env()
    • create_procgen_env()
    • create_simpletag_env()
    • evaluate_random_policy()
    • evaluate_random_policy_gymnasium()
    • evaluate_random_policy_pettingzoo()
    • get_test_actions()
    • get_test_values()
    • run_episode()
    • run_episodes()
    • run_episodes_queue()
    • run_gymnasium_episode()
    • run_native_multiprocess()
    • run_native_vecenv()
    • run_pettingzoo_episode()
    • run_ray_multiprocess()
    • run_set_length()
    • run_single_process()
  • Module contents
• Curricula
  • Module contents

Submodules

syllabus.utils module

exception syllabus.utils.UsageError

Bases: Exception

syllabus.utils.decorate_all_functions(function_decorator)

syllabus.utils.enumerate_axes(list_or_size: ndarray | int)