p2pfl package

Main package for the p2pfl project.

It contains the main classes (Node, NodeState…) and functions to run the project.

Please check the submodules for more information.

Subpackages

• p2pfl.communication package
  • Subpackages
    • p2pfl.communication.commands package
      • Subpackages
      • Submodules
    • p2pfl.communication.protocols package
      • Subpackages
      • Submodules
• p2pfl.examples package
  • Submodules
    • p2pfl.examples.mnist module
      • create_pytorch_model()
      • create_tensorflow_model()
      • mnist()
      • set_standalone_settings()
    • p2pfl.examples.node1 module
      • node1()
    • p2pfl.examples.node2 module
      • node2()
• p2pfl.learning package
  • Subpackages
    • p2pfl.learning.aggregators package
      • Submodules
    • p2pfl.learning.dataset package
      • Submodules
    • p2pfl.learning.frameworks package
      • Framework
      • Subpackages
      • Submodules
• p2pfl.management package
  • Subpackages
    • p2pfl.management.logger package
      • Submodules
  • Submodules
    • p2pfl.management.metric_storage module
      • GlobalMetricStorage
      • LocalMetricStorage
    • p2pfl.management.node_monitor module
      • NodeMonitor
    • p2pfl.management.p2pfl_web_services module
      • P2pflWebServices
      • P2pflWebServicesError
• p2pfl.stages package
  • Subpackages
    • p2pfl.stages.base_node package
      • Submodules
  • Submodules
    • p2pfl.stages.stage module
      • EarlyStopException
      • Stage
      • check_early_stop()
    • p2pfl.stages.stage_factory module
      • StageFactory
    • p2pfl.stages.workflows module
      • LearningWorkflow
      • StageWokflow

Submodules

• p2pfl.cli module
  • check_example_exists()
  • help()
  • launch()
  • list()
  • login()
  • remote()
  • run()
• p2pfl.exceptions module
  • LearnerRunningException
  • NodeRunningException
  • ZeroRoundsException
• p2pfl.experiment module
  • Experiment
    • Experiment.exp_name
    • Experiment.total_rounds
    • Experiment.round
    • Experiment.increase_round()
    • Experiment.self()
• p2pfl.node module
  • Node
    • Node.assert_running()
    • Node.connect()
    • Node.disconnect()
    • Node.get_data()
    • Node.get_model()
    • Node.get_neighbors()
    • Node.set_data()
    • Node.set_learner()
    • Node.set_model()
    • Node.set_start_learning()
    • Node.set_stop_learning()
    • Node.start()
    • Node.stop()
• p2pfl.node_state module
  • NodeState
    • NodeState.addr
    • NodeState.status
    • NodeState.simulation
    • NodeState.learner
    • NodeState.models_aggregated
    • NodeState.nei_status
    • NodeState.train_set
    • NodeState.train_set_votes
    • NodeState.train_set_votes_lock
    • NodeState.start_thread_lock
    • NodeState.wait_votes_ready_lock
    • NodeState.model_initialized_lock
    • NodeState.clear()
    • NodeState.exp_name
    • NodeState.increase_round()
    • NodeState.round
    • NodeState.set_experiment()
      • NodeState.exp_name
      • NodeState.total_rounds
    • NodeState.total_rounds
• p2pfl.settings module
  • Settings
    • Settings.AGGREGATION_TIMEOUT
    • Settings.AMOUNT_LAST_MESSAGES_SAVED
    • Settings.CA_CRT
    • Settings.CLIENT_CRT
    • Settings.CLIENT_KEY
    • Settings.DISABLE_RAY
    • Settings.EXCLUDE_BEAT_LOGS
    • Settings.GOSSIP_EXIT_ON_X_EQUAL_ROUNDS
    • Settings.GOSSIP_MESSAGES_PER_PERIOD
    • Settings.GOSSIP_MODELS_PERIOD
    • Settings.GOSSIP_MODELS_PER_ROUND
    • Settings.GOSSIP_PERIOD
    • Settings.GRPC_TIMEOUT
    • Settings.HEARTBEAT_PERIOD
    • Settings.HEARTBEAT_TIMEOUT
    • Settings.LOG_DIR
    • Settings.LOG_LEVEL
    • Settings.RESOURCE_MONITOR_PERIOD
    • Settings.SERVER_CRT
    • Settings.SERVER_KEY
    • Settings.TRAIN_SET_SIZE
    • Settings.TTL
    • Settings.USE_SSL
    • Settings.VOTE_TIMEOUT
    • Settings.WAIT_HEARTBEATS_CONVERGENCE