Substra
0.21.0
Substrafl documentation
Overview
API reference
Substrafl examples
Substra documentation
Main Substra concepts
How to test code and understand errors
Performance monitoring in local mode
GPU usage
API reference
Substra examples
Operating Substra
Components
Deploying Substra
Upgrade notes
Additional Information
Community
Release notes
Glossary
Substra
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
Z
_
__iter__() (substrafl.evaluation_strategy.EvaluationStrategy method)
(substrafl.index_generator.np_index_generator.NpIndexGenerator method)
__next__() (substrafl.evaluation_strategy.EvaluationStrategy method)
(substrafl.index_generator.np_index_generator.NpIndexGenerator method)
_get_state_to_save() (substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
_get_torch_device() (substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
_local_predict() (substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
_local_train() (substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
_member_type_ (substrafl.schemas.StrategyName attribute)
_Model (class in substrafl.schemas)
_save_predictions() (substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
_scaffold_parameters_update() (substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
_update_from_checkpoint() (substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
_update_gradients_and_hessian() (substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
A
add_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
aggregate() (substrafl.remote.substratools_methods.RemoteMethod method)
AggregateOperation (class in substrafl.remote.operations)
AggregationNode (class in substrafl.nodes.aggregation_node)
Algo (class in substrafl.algorithms.algo)
avg_shared_states() (substrafl.strategies.FedAvg method)
(substrafl.strategies.Scaffold method)
B
BaseIndexGenerator (class in substrafl.index_generator.base)
batch_norm_param() (in module substrafl.algorithms.pytorch.weight_manager)
batch_size (substrafl.index_generator.base.BaseIndexGenerator property)
(substrafl.index_generator.np_index_generator.NpIndexGenerator property)
BatchSizeNotFoundError
C
Channel
check_num_updates() (substrafl.index_generator.base.BaseIndexGenerator method)
(substrafl.index_generator.np_index_generator.NpIndexGenerator method)
check_setup() (substrafl.dependency.Dependency class method)
compute_averaged_states() (substrafl.strategies.NewtonRaphson method)
counter (substrafl.index_generator.base.BaseIndexGenerator property)
(substrafl.index_generator.np_index_generator.NpIndexGenerator property)
CriterionReductionError
CUpdateRule (class in substrafl.algorithms.pytorch.torch_scaffold_algo)
D
DampingFactorValueError
DataOperation (class in substrafl.remote.operations)
DatasetSignatureError
DatasetTypeError
Dependency (class in substrafl.dependency)
download_algo_files() (in module substrafl.model_loading)
E
EmptySharedStatesError
EvaluationStrategy (class in substrafl.evaluation_strategy)
execute_experiment() (in module substrafl.experiment)
F
FedAvg (class in substrafl.strategies)
FedAvgAveragedState (class in substrafl.schemas)
FedAvgSharedState (class in substrafl.schemas)
G
get_cls_file_path() (substrafl.remote.remote_struct.RemoteStruct method)
get_instance() (substrafl.remote.remote_struct.RemoteStruct method)
get_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
get_remote_instance() (substrafl.remote.remote_struct.RemoteStruct method)
I
IncompatibleAlgoStrategyError
increment_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
IndexGeneratorSampleNoneError
IndexGeneratorUpdateError
InvalidPathError
is_batchnorm_layer() (in module substrafl.algorithms.pytorch.weight_manager)
K
KeyMetadataError
L
LenMetadataError
load() (substrafl.algorithms.algo.Algo method)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
(substrafl.remote.remote_struct.RemoteStruct class method)
(substrafl.remote.serializers.PickleSerializer static method)
load_algo() (in module substrafl.model_loading)
load_head_model() (substrafl.remote.substratools_methods.RemoteDataMethod method)
load_model() (substrafl.remote.substratools_methods.RemoteMethod method)
load_trunk_model() (substrafl.remote.substratools_methods.RemoteDataMethod method)
LoadAlgoFileNotFoundError
LoadAlgoLocalDependencyError
LoadAlgoMetadataError
local_lib_wheels() (in module substrafl.remote.register.generate_wheel)
LocalStateRef (class in substrafl.nodes.references.local_state)
M
model (substrafl.algorithms.algo.Algo property)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo property)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo property)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo property)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo property)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo property)
model_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
module
substrafl.algorithms.pytorch.torch_newton_raphson_algo
substrafl.algorithms.pytorch.torch_scaffold_algo
substrafl.algorithms.pytorch.weight_manager
substrafl.dependency
substrafl.exceptions
substrafl.experiment
substrafl.model_loading
substrafl.nodes.references
substrafl.remote.decorators
substrafl.remote.operations
substrafl.remote.register.generate_wheel
substrafl.remote.register.register
substrafl.remote.serializers
substrafl.remote.substratools_methods
substrafl.schemas
MultipleTrainTaskError
N
n_epoch_generated (substrafl.index_generator.base.BaseIndexGenerator property)
(substrafl.index_generator.np_index_generator.NpIndexGenerator property)
n_samples (substrafl.index_generator.base.BaseIndexGenerator property)
(substrafl.index_generator.np_index_generator.NpIndexGenerator property)
name (substrafl.strategies.FedAvg property)
(substrafl.strategies.NewtonRaphson property)
(substrafl.strategies.Scaffold property)
(substrafl.strategies.SingleOrganization property)
(substrafl.strategies.strategy.Strategy property)
NegativeHessianMatrixError
NewtonRaphson (class in substrafl.strategies)
NewtonRaphsonAveragedStates (class in substrafl.schemas)
NewtonRaphsonSharedState (class in substrafl.schemas)
Node (class in substrafl.nodes.node)
NpIndexGenerator (class in substrafl.index_generator.np_index_generator)
num_rounds (substrafl.evaluation_strategy.EvaluationStrategy property)
num_updates (substrafl.index_generator.base.BaseIndexGenerator property)
(substrafl.index_generator.np_index_generator.NpIndexGenerator property)
NumUpdatesValueError
O
OperationKey (class in substrafl.nodes.node)
OptimizerValueError
Organization
P
perform_round() (substrafl.strategies.FedAvg method)
(substrafl.strategies.NewtonRaphson method)
(substrafl.strategies.Scaffold method)
(substrafl.strategies.SingleOrganization method)
(substrafl.strategies.strategy.Strategy method)
PickleSerializer (class in substrafl.remote.serializers)
predict() (substrafl.algorithms.algo.Algo method)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
(substrafl.remote.substratools_methods.RemoteDataMethod method)
(substrafl.remote.substratools_methods.RemoteMethod method)
(substrafl.strategies.FedAvg method)
(substrafl.strategies.NewtonRaphson method)
(substrafl.strategies.Scaffold method)
(substrafl.strategies.SingleOrganization method)
(substrafl.strategies.strategy.Strategy method)
pypi_lib_wheels() (in module substrafl.remote.register.generate_wheel)
R
register_algo() (in module substrafl.remote.register.register)
register_operations() (substrafl.nodes.aggregation_node.AggregationNode method)
(substrafl.nodes.train_data_node.TrainDataNode method)
register_predict_operations() (substrafl.nodes.test_data_node.TestDataNode method)
remote() (in module substrafl.remote.decorators)
remote_data() (in module substrafl.remote.decorators)
RemoteDataMethod (class in substrafl.remote.substratools_methods)
RemoteMethod (class in substrafl.remote.substratools_methods)
RemoteStruct (class in substrafl.remote.remote_struct)
reset_counter() (substrafl.index_generator.base.BaseIndexGenerator method)
(substrafl.index_generator.np_index_generator.NpIndexGenerator method)
resolve_path() (substrafl.dependency.Dependency class method)
restart_rounds() (substrafl.evaluation_strategy.EvaluationStrategy method)
S
save() (substrafl.algorithms.algo.Algo method)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
(substrafl.remote.remote_struct.RemoteStruct method)
(substrafl.remote.serializers.PickleSerializer static method)
(substrafl.remote.serializers.Serializer static method)
save_head_model() (substrafl.remote.substratools_methods.RemoteDataMethod method)
save_trunk_model() (substrafl.remote.substratools_methods.RemoteDataMethod method)
Scaffold (class in substrafl.strategies)
ScaffoldAveragedStates (class in substrafl.schemas)
ScaffoldLearningRateError
ScaffoldSharedState (class in substrafl.schemas)
Serializer (class in substrafl.remote.serializers)
set_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
SharedStateRef (class in substrafl.nodes.references.shared_state)
SharedStatesError
SingleOrganization (class in substrafl.strategies)
strategies (substrafl.algorithms.algo.Algo property)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo property)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo property)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo property)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo property)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo property)
Strategy (class in substrafl.strategies.strategy)
StrategyName (class in substrafl.schemas)
substrafl.algorithms.pytorch.torch_newton_raphson_algo
module
substrafl.algorithms.pytorch.torch_scaffold_algo
module
substrafl.algorithms.pytorch.weight_manager
module
substrafl.dependency
module
substrafl.exceptions
module
substrafl.experiment
module
substrafl.model_loading
module
substrafl.nodes.references
module
substrafl.remote.decorators
module
substrafl.remote.operations
module
substrafl.remote.register.generate_wheel
module
substrafl.remote.register.register
module
substrafl.remote.serializers
module
substrafl.remote.substratools_methods
module
substrafl.schemas
module
SubstraToolsDeprecationWarning
subtract_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
summary() (substrafl.algorithms.algo.Algo method)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
(substrafl.nodes.node.Node method)
(substrafl.nodes.test_data_node.TestDataNode method)
(substrafl.nodes.train_data_node.TrainDataNode method)
(substrafl.remote.remote_struct.RemoteStruct method)
T
TestDataNode (class in substrafl.nodes.test_data_node)
TorchAlgo (class in substrafl.algorithms.pytorch.torch_base_algo)
TorchFedAvgAlgo (class in substrafl.algorithms.pytorch)
TorchNewtonRaphsonAlgo (class in substrafl.algorithms.pytorch.torch_newton_raphson_algo)
TorchScaffoldAlgo (class in substrafl.algorithms.pytorch.torch_scaffold_algo)
TorchScaffoldAlgoParametersUpdateError
TorchSingleOrganizationAlgo (class in substrafl.algorithms.pytorch)
train() (substrafl.algorithms.algo.Algo method)
(substrafl.algorithms.pytorch.torch_base_algo.TorchAlgo method)
(substrafl.algorithms.pytorch.torch_newton_raphson_algo.TorchNewtonRaphsonAlgo method)
(substrafl.algorithms.pytorch.torch_scaffold_algo.TorchScaffoldAlgo method)
(substrafl.algorithms.pytorch.TorchFedAvgAlgo method)
(substrafl.algorithms.pytorch.TorchSingleOrganizationAlgo method)
(substrafl.remote.substratools_methods.RemoteDataMethod method)
TrainDataNode (class in substrafl.nodes.train_data_node)
TrainTaskNotFoundError
U
UnfinishedTrainTaskError
UnsupportedPytorchVersionError
update_states() (substrafl.nodes.aggregation_node.AggregationNode method)
(substrafl.nodes.test_data_node.TestDataNode method)
(substrafl.nodes.train_data_node.TrainDataNode method)
W
weighted_sum_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
Z
zeros_like_parameters() (in module substrafl.algorithms.pytorch.weight_manager)
Read the Docs
v: 0.21.0
Versions
latest
stable
0.21.0
Downloads
On Read the Docs
Project Home
Builds