SubstraFL API reference

• Experiment
  • execute_experiment()
  • simulate_experiment()
• Algorithms
  • Torch Algorithms
  • Torch functions
  • Base Class
• Dependency
  • Schemas
  • Manage Dependencies
• Evaluation Strategy
  • EvaluationStrategy
• Model Downloading
  • download_aggregate_shared_state()
  • download_algo_state()
  • download_train_shared_state()
• Exceptions
  • ArgumentConflictError
  • BatchSizeNotFoundError
  • CriterionReductionError
  • DampingFactorValueError
  • DatasetSignatureError
  • DatasetTypeError
  • DependencyCacheNotFoundError
  • EmptySharedStatesError
  • ExistingRegisteredMetricError
  • IncompatibleAlgoStrategyError
  • IndexGeneratorSampleNoneError
  • IndexGeneratorUpdateError
  • InvalidDependenciesError
  • InvalidMetricIdentifierError
  • InvalidPathError
  • InvalidUserModuleError
  • KeyMetadataError
  • LenMetadataError
  • LoadFileNotFoundError
  • LoadLocalDependencyError
  • LoadMetadataError
  • MetricFunctionSignatureError
  • MetricFunctionTypeError
  • MultipleTaskError
  • NegativeHessianMatrixError
  • NumUpdatesValueError
  • OptimizerValueError
  • ScaffoldLearningRateError
  • SharedStatesError
  • SubstraToolsDeprecationWarning
  • TaskNotFoundError
  • TorchScaffoldAlgoParametersUpdateError
  • UnfinishedTaskError
  • UnsupportedClientBackendTypeError
  • UnsupportedPythonVersionError
  • UnsupportedPytorchVersionError
  • WrongWheelNameError
• Index Generator
  • NpIndexGenerator
  • Base class
• Nodes
  • AggregationNode
  • TrainDataNode
  • TestDataNode
  • Protocols
  • References
• Remote
  • Decorator
  • Remote Struct
  • Operations
  • Substra tools methods
  • Register
  • Serializers
• Strategies
  • Federated Averaging
  • Scaffold
  • Newton Raphson
  • Fed PCA
  • Single Organization
  • Strategies Base Class
  • Schemas
• Compute Plan Builder
  • ComputePlanBuilder
• Logger
  • set_logging_level()