API Reference

Public API

• Running Experiments (nip.run)
  • Basic Workflow
  • Example
  • Preparing Experiments
  • Module Contents
• Experiment Hyper-Parameters (nip.parameters)
  • Overview
  • Examples
  • Specifying Agent Parameters
  • Converting to and from Nested Dicts
  • Creating New Parameters
  • Main Hyper-Parameters Class
  • Modules for Sub-Parameters
  • Bases Classes and Enum Types
  • Handling Parameter Versions
  • Registering Parameter Classes
• Experiment Scripts
  • The Graph Isomorphism Task
  • The Image Classification Task
  • The Code Validation Task
  • Miscellaneous Scripts

Developer API

• Interaction Protocols (nip.protocols)
  • Overview
  • Creating a New Protocol
  • Base Classes
  • Built-In Protocols
  • Zero-Knowledge Protocols
  • Code Validation Protocols
  • Protocol Registry
• Scenarios
  • What is a Scenario?
  • TensorDict or Pure Text Scenario?
  • Base Classes
  • Available Scenarios
  • Scenario Hyper-Parameters
  • How scenarios get instantiated (nip.factory)
• Trainers (nip.trainers)
  • Overview
  • TensorDict or Pure Text Trainer?
  • Base classes
  • Available Trainers
  • Trainer Registry
• Experiment Settings (nip.experiment_settings)
  • ExperimentSettings
• Global Constants (nip.constants)
  • CACHED_MODELS_DIR
  • CACHED_MODELS_METADATA_FILENAME
  • CV_DATA_DIR
  • DATA_DIR
  • ENV_FILE
  • EXPERIMENT_STATE_DIR
  • GI_DATA_DIR
  • HF_BUGGY_APPS_REPO
  • HF_PRETRAINED_MODELS_USER
  • IC_DATA_DIR
  • LOG_DIR
  • SEEDS
• Auxiliary Modules
  • nip.rl_objectives
  • nip.utils
  • nip.stat_logger
  • nip.artifact_logger
  • nip.base_run
  • nip.model_cache
  • nip.timing