Skip to main content
Ctrl+K

Neural Interactive Proofs documentation

  • Guides
    • Installation
    • Running Experiments
    • Contributing
    • How an Experiment is Built
    • Creating a New Protocol
    • Creating a New Trainer
    • Using a Docker Image
  • API Reference
    • Running Experiments (nip.run)
    • Experiment Hyper-Parameters (nip.parameters)
      • nip.parameters.protocol
        • nip.parameters.protocol.CommonProtocolParameters
        • nip.parameters.protocol.DebateProtocolParameters
        • nip.parameters.protocol.LongProtocolParameters
        • nip.parameters.protocol.MnipProtocolParameters
        • nip.parameters.protocol.NipProtocolParameters
        • nip.parameters.protocol.ZkProtocolParameters
      • nip.parameters.trainers
        • nip.parameters.trainers.CommonPpoParameters
        • nip.parameters.trainers.PureTextEiParameters
        • nip.parameters.trainers.PureTextMaltParameters
        • nip.parameters.trainers.ReinforceParameters
        • nip.parameters.trainers.RlTrainerParameters
        • nip.parameters.trainers.SoloAgentParameters
        • nip.parameters.trainers.SpgParameters
        • nip.parameters.trainers.TextRlParameters
        • nip.parameters.trainers.VanillaPpoParameters
      • nip.parameters.agents
        • nip.parameters.agents.AgentParameters
        • nip.parameters.agents.AgentsParameters
        • nip.parameters.agents.CodeValidationAgentParameters
        • nip.parameters.agents.GraphIsomorphismAgentParameters
        • nip.parameters.agents.ImageClassificationAgentParameters
        • nip.parameters.agents.LrFactors
        • nip.parameters.agents.PureTextAgentParameters
        • nip.parameters.agents.RandomAgentParameters
      • nip.parameters.dataset
        • nip.parameters.dataset.DatasetParameters
      • nip.parameters.scenario
        • nip.parameters.scenario.CodeValidationParameters
        • nip.parameters.scenario.ImageClassificationParameters
      • nip.parameters.base_run
        • nip.parameters.base_run.BaseRunParameters
        • nip.parameters.base_run.BaseRunPreserve
      • nip.parameters.message_regression
        • nip.parameters.message_regression.MessageRegressionParameters
      • nip.parameters.update_schedule
        • nip.parameters.update_schedule.AgentUpdateSchedule
        • nip.parameters.update_schedule.AlternatingPeriodicUpdateSchedule
        • nip.parameters.update_schedule.ConstantUpdateSchedule
        • nip.parameters.update_schedule.ContiguousPeriodicUpdateSchedule
      • nip.parameters.parameters_base
        • nip.parameters.parameters_base.get_parameter_class
        • nip.parameters.parameters_base.get_parameter_or_parameter_value_class
        • nip.parameters.parameters_base.register_parameter_class
        • nip.parameters.parameters_base.register_parameter_value_class
        • nip.parameters.parameters_base.BaseHyperParameters
        • nip.parameters.parameters_base.ParameterValue
        • nip.parameters.parameters_base.SubParameters
      • nip.parameters.types
        • nip.parameters.types.ScenarioType
        • nip.parameters.types.SpgVariantType
        • nip.parameters.types.IhvpVariantType
        • nip.parameters.types.GuessType
        • nip.parameters.types.TrainerType
        • nip.parameters.types.TestSchemeType
        • nip.parameters.types.PpoLossType
        • nip.parameters.types.BinarificationMethodType
        • nip.parameters.types.ActivationType
        • nip.parameters.types.InteractionProtocolType
        • nip.parameters.types.ImageBuildingBlockType
        • nip.parameters.types.MessageRegressionMethodType
        • nip.parameters.types.BaseRunType
      • nip.parameters.version
        • nip.parameters.version._from_0_1_to_1_0
        • nip.parameters.version._from_none_to_0_1
        • nip.parameters.version.convert_hyper_param_dict
        • nip.parameters.version.register_conversion_function
        • nip.parameters.version.ConversionFunctionNotFoundError
        • nip.parameters.version.MultipleConversionFunctionsMatchError
    • Experiment Scripts
      • ppo_gi.py
      • dummy_test_gi.py
      • solo_agents_gi.py
      • create_gi_dataset.py
      • ppo_ic.py
      • solo_agents_ic.py
      • dummy_test_ic.py
      • ei_cv.py
      • create_cv_dataset.py
      • download_all_datasets.py
      • time_timeable.py
    • Interaction Protocols (nip.protocols)
      • nip.protocols.protocol_base.ProtocolHandler
      • nip.protocols.protocol_base.SingleVerifierProtocolHandler
      • nip.protocols.protocol_base.DeterministicSingleVerifierProtocolHandler
      • nip.protocols.main_protocols.NipProtocol
      • nip.protocols.main_protocols.AdpProtocol
      • nip.protocols.main_protocols.DebateProtocol
      • nip.protocols.main_protocols.MerlinArthurProtocol
      • nip.protocols.main_protocols.MnipProtocol
      • nip.protocols.main_protocols.SoloVerifierProtocol
      • nip.protocols.main_protocols.MultiChannelTestProtocol
      • nip.protocols.zero_knowledge.ZeroKnowledgeProtocol
    • Scenarios
      • nip.scenario_base.data
        • nip.scenario_base.data.Dataset
        • nip.scenario_base.data.NestedArrayDictDataLoader
        • nip.scenario_base.data.NestedArrayDictDataset
        • nip.scenario_base.data.TensorDictDataLoader
        • nip.scenario_base.data.TensorDictDataset
        • nip.scenario_base.data.TensorDictSingleProcessDataLoaderIter
        • nip.scenario_base.data.CachedPretrainedEmbeddingsNotFound
      • nip.scenario_base.environment
        • nip.scenario_base.environment.Environment
        • nip.scenario_base.environment.PromptMessage
        • nip.scenario_base.environment.PureTextEnvironment
        • nip.scenario_base.environment.TensorDictEnvironment
      • nip.scenario_base.agents
        • nip.scenario_base.agents.Agent
        • nip.scenario_base.agents.AgentBody
        • nip.scenario_base.agents.AgentHead
        • nip.scenario_base.agents.AgentHooks
        • nip.scenario_base.agents.AgentPart
        • nip.scenario_base.agents.AgentPolicyHead
        • nip.scenario_base.agents.AgentState
        • nip.scenario_base.agents.AgentValueHead
        • nip.scenario_base.agents.CombinedAgentPart
        • nip.scenario_base.agents.CombinedBody
        • nip.scenario_base.agents.CombinedPolicyHead
        • nip.scenario_base.agents.CombinedTensorDictAgentPart
        • nip.scenario_base.agents.CombinedValueHead
        • nip.scenario_base.agents.CombinedWhole
        • nip.scenario_base.agents.ConstantAgentValueHead
        • nip.scenario_base.agents.DummyAgentBody
        • nip.scenario_base.agents.PureTextCombinedWhole
        • nip.scenario_base.agents.PureTextSharedModelGroup
        • nip.scenario_base.agents.PureTextSharedModelGroupState
        • nip.scenario_base.agents.PureTextWholeAgent
        • nip.scenario_base.agents.RandomAgentPolicyHead
        • nip.scenario_base.agents.RandomWholeAgent
        • nip.scenario_base.agents.SoloAgentHead
        • nip.scenario_base.agents.TensorDictAgentPartMixin
        • nip.scenario_base.agents.TensorDictDummyAgentPartMixin
        • nip.scenario_base.agents.WholeAgent
      • nip.scenario_base.pretrained_models
        • nip.scenario_base.pretrained_models.get_pretrained_model_class
        • nip.scenario_base.pretrained_models.register_pretrained_model_class
        • nip.scenario_base.pretrained_models.PretrainedModel
      • nip.scenario_base.rollout_analysis
        • nip.scenario_base.rollout_analysis.register_rollout_analyser
        • nip.scenario_base.rollout_analysis.PureTextRolloutAnalyser
        • nip.scenario_base.rollout_analysis.RolloutAnalyser
      • nip.scenario_base.rollout_samples
        • nip.scenario_base.rollout_samples.build_rollout_samples
        • nip.scenario_base.rollout_samples.register_rollout_samples_class
        • nip.scenario_base.rollout_samples.RolloutSamples
        • nip.scenario_base.rollout_samples.IterationNotFoundError
      • nip.graph_isomorphism
        • nip.graph_isomorphism.agents
        • nip.graph_isomorphism.data
        • nip.graph_isomorphism.dataset_generation
        • nip.graph_isomorphism.environment
        • nip.graph_isomorphism.rollout_samples
      • nip.image_classification
        • nip.image_classification.agents
        • nip.image_classification.data
        • nip.image_classification.environment
        • nip.image_classification.pretrained_models
      • nip.code_validation
        • nip.code_validation.agents
        • nip.code_validation.data
        • nip.code_validation.dataset_generation
        • nip.code_validation.environment
        • nip.code_validation.protocols
        • nip.code_validation.rollout_analysis
      • nip.scenario_instance
        • nip.scenario_instance.ScenarioInstance
      • nip.factory
        • nip.factory._add_pretrained_embeddings_to_datasets
        • nip.factory._build_agents
        • nip.factory._build_components_for_rl_trainer
        • nip.factory.build_scenario_instance
        • nip.factory.register_scenario_class
        • nip.factory._ParameterSelector
    • Trainers (nip.trainers)
      • nip.trainers.trainer_base
        • nip.trainers.trainer_base.attach_progress_bar
        • nip.trainers.trainer_base.IterationContext
        • nip.trainers.trainer_base.TensorDictTrainer
        • nip.trainers.trainer_base.Trainer
        • nip.trainers.trainer_base.CheckPointNotFoundError
      • nip.trainers.rl_tensordict_base
        • nip.trainers.rl_tensordict_base.update_schedule_iterator
        • nip.trainers.rl_tensordict_base.TensorDictRlTrainer
      • nip.trainers.rl_pure_text_base
        • nip.trainers.rl_pure_text_base.PureTextRlTrainer
      • nip.trainers.solo_agent
        • nip.trainers.solo_agent.SoloAgentTrainer
      • nip.trainers.vanilla_ppo
        • nip.trainers.vanilla_ppo.VanillaPpoTrainer
      • nip.trainers.spg
        • nip.trainers.spg.SpgTrainer
      • nip.trainers.reinforce
        • nip.trainers.reinforce.ReinforceTrainer
      • nip.trainers.ei_pure_text
        • nip.trainers.ei_pure_text.PureTextEiTrainer
      • nip.trainers.malt_pure_text
        • nip.trainers.malt_pure_text._compute_tree_expected_reward
        • nip.trainers.malt_pure_text._generate_response_tree
        • nip.trainers.malt_pure_text._sample_positive_and_negative_examples
        • nip.trainers.malt_pure_text._tree_iter
        • nip.trainers.malt_pure_text.PureTextMaltTrainer
        • nip.trainers.malt_pure_text._PartialRolloutNode
    • Experiment Settings (nip.experiment_settings)
    • Global Constants (nip.constants)
    • Auxiliary Modules
      • nip.rl_objectives
        • nip.rl_objectives.ClipPPOLossImproved
        • nip.rl_objectives.KLPENPPOLossImproved
        • nip.rl_objectives.Objective
        • nip.rl_objectives.PPOLossImproved
        • nip.rl_objectives.ReinforceLossImproved
        • nip.rl_objectives.SpgLoss
      • nip.utils
        • nip.utils.api
        • nip.utils.apps_metric
        • nip.utils.bugfix
        • nip.utils.data
        • nip.utils.distributions
        • nip.utils.env
        • nip.utils.experiments
        • nip.utils.hyper_params
        • nip.utils.io
        • nip.utils.maths
        • nip.utils.nested_array_dict
        • nip.utils.oop
        • nip.utils.output
        • nip.utils.runtime_module
        • nip.utils.string
        • nip.utils.tensordict
        • nip.utils.timing
        • nip.utils.torch
        • nip.utils.training
        • nip.utils.types
        • nip.utils.version
      • nip.stat_logger
        • nip.stat_logger.DummyStatLogger
        • nip.stat_logger.StatLogger
        • nip.stat_logger.WandbStatLogger
      • nip.artifact_logger
        • nip.artifact_logger.ArtifactLogger
      • nip.base_run
        • nip.base_run.get_base_wandb_run_and_new_hyper_params
      • nip.model_cache
        • nip.model_cache.cached_models_exist
        • nip.model_cache.get_cached_models_path
        • nip.model_cache.load_cached_model_state_dicts
        • nip.model_cache.save_model_state_dicts
        • nip.model_cache.ModelNotFoundError
      • nip.timing
        • nip.timing.models
        • nip.timing.run
        • nip.timing.timeables
  • Changelog
  • Glossary
  • Bibliography
  • .rst

Guides

Guides#

Contents:

  • Installation
    • Prerequisites
    • Installation Steps
    • Next Steps
  • Running Experiments
    • Overview
    • Specifying Hyper-Parameters
    • Additional Experiment Settings
    • Experiment Scripts
  • Contributing
    • Issues and Pull Requests
    • Style Guide
    • Testing
    • Documentation
    • Pre-Commit Hooks
    • Development Workflow
  • How an Experiment is Built
  • Creating a New Protocol
    • Main Steps
    • Base Classes
    • Properties That All Protocols Need to Define
    • Methods to Define
    • Specifying Additional Details for the Code Validation Task
    • Zero-Knowledge Protocols
    • Testing Protocols
    • Example
  • Creating a New Trainer
    • Which Parts of this Guide to Read
    • Main Steps
    • Trainer Base Classes
    • Available Experiment Components
  • Using a Docker Image
    • Requirements
    • Building and Pushing the Image

previous

Neural Interactive Proofs Documentation

next

Installation

By Sam Adam-Day and Lewis Hammond

© Copyright 2025, Sam Adam-Day and Lewis Hammond.

arXiv | OpenReview | GitHub | Website