FedJAX
latest
Getting started
Federated datasets
Working with models in FedJAX
Federated learning algorithms
Developer documentation
Contributing
Building from source
Running the tests
Updating the docs
API reference
fedjax core
fedjax.aggregators
fedjax.algorithms
fedjax.datasets
fedjax.models
fedjax.training
FedJAX
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
Z
_
__call__() (fedjax.ClientPreprocessor method)
(fedjax.training.EvaluationFn method)
(fedjax.training.ModelFullEvaluationFn method)
(fedjax.training.ModelSampleClientsEvaluationFn method)
(fedjax.training.ModelTrainClientsEvaluationFn method)
(fedjax.training.TrainClientsEvaluationFn method)
__getitem__() (fedjax.ClientDataset method)
__init__() (fedjax.algorithms.hyp_cluster.HypClusterEvaluator method)
(fedjax.algorithms.hyp_cluster.ModelKMeansInitializer method)
(fedjax.AverageLossEvaluator method)
(fedjax.BatchPreprocessor method)
(fedjax.ClientDataset method)
(fedjax.ClientPreprocessor method)
(fedjax.datasets.stackoverflow.StackoverflowTokenizer method)
(fedjax.InMemoryFederatedData method)
(fedjax.ModelEvaluator method)
(fedjax.SQLiteFederatedData method)
(fedjax.SQLiteFederatedDataBuilder method)
(fedjax.SubsetFederatedData method)
(fedjax.training.Logger method)
(fedjax.training.ModelFullEvaluationFn method)
(fedjax.training.ModelSampleClientsEvaluationFn method)
(fedjax.training.ModelTrainClientsEvaluationFn method)
__len__() (fedjax.ClientDataset method)
A
accum (fedjax.metrics.MeanStat attribute)
(fedjax.metrics.SumStat attribute)
Accuracy (class in fedjax.metrics)
adagrad() (in module fedjax.optimizers)
adam() (in module fedjax.optimizers)
add_many() (fedjax.FederatedDataBuilder method)
Aggregator (class in fedjax.aggregators)
agnostic_federated_averaging() (in module fedjax.algorithms.agnostic_fed_avg)
all_examples() (fedjax.ClientDataset method)
ALL_TASKS (fedjax.training attribute)
append() (fedjax.BatchPreprocessor method)
(fedjax.ClientPreprocessor method)
apply (fedjax.aggregators.Aggregator attribute)
(fedjax.FederatedAlgorithm attribute)
(fedjax.optimizers.Optimizer attribute)
apply_for_eval (fedjax.Model attribute)
apply_for_train (fedjax.Model attribute)
AverageLossEvaluator (class in fedjax)
B
batch() (fedjax.ClientDataset method)
BatchHParamsFlags (class in fedjax.training.structured_flags)
BatchPreprocessor (class in fedjax)
buffered_shuffle_batch_client_datasets() (in module fedjax)
C
cite() (in module fedjax.datasets.cifar100)
(in module fedjax.datasets.emnist)
(in module fedjax.datasets.shakespeare)
(in module fedjax.datasets.stackoverflow)
client_ids() (fedjax.FederatedData method)
client_size() (fedjax.FederatedData method)
client_sizes() (fedjax.FederatedData method)
ClientDataset (class in fedjax)
ClientPreprocessor (class in fedjax)
clients() (fedjax.FederatedData method)
cluster_params (fedjax.algorithms.hyp_cluster.ServerState attribute)
cluster_params() (fedjax.algorithms.hyp_cluster.ModelKMeansInitializer method)
ConfusionMatrix (class in fedjax.metrics)
ConvDropoutModule (class in fedjax.models.emnist)
create_conv_model() (in module fedjax.models.emnist)
create_dense_model() (in module fedjax.models.emnist)
create_logistic_model() (in module fedjax.models.emnist)
create_lstm_model() (in module fedjax.models.shakespeare)
(in module fedjax.models.stackoverflow)
create_model_from_haiku() (in module fedjax)
create_model_from_stax() (in module fedjax)
create_optimizer_from_optax() (in module fedjax.optimizers)
create_regression_model() (in module fedjax.models.toy_regression)
create_stax_dense_model() (in module fedjax.models.emnist)
CrossEntropyLoss (class in fedjax.metrics)
D
domain_id() (in module fedjax.datasets.emnist)
domain_weights (fedjax.algorithms.agnostic_fed_avg.ServerState attribute)
domain_window (fedjax.algorithms.agnostic_fed_avg.ServerState attribute)
Dropout (class in fedjax.models.emnist)
E
eos_target_value (fedjax.metrics.SequenceTruncationRate attribute)
eval_metrics (fedjax.Model attribute)
evaluate_average_loss() (in module fedjax)
evaluate_batch() (in module fedjax.metrics)
evaluate_clients() (fedjax.algorithms.hyp_cluster.HypClusterEvaluator method)
evaluate_example() (fedjax.metrics.Metric method)
evaluate_global_params() (fedjax.AverageLossEvaluator method)
(fedjax.ModelEvaluator method)
evaluate_model() (in module fedjax)
evaluate_per_client_params() (fedjax.AverageLossEvaluator method)
(fedjax.ModelEvaluator method)
EvaluationFn (class in fedjax.training)
F
federated_averaging() (in module fedjax.algorithms.fed_avg)
FederatedAlgorithm (class in fedjax)
FederatedData (class in fedjax)
FederatedDataBuilder (class in fedjax)
FederatedExperimentConfig (class in fedjax.training)
FederatedExperimentConfigFlags (class in fedjax.training.structured_flags)
fedjax
module
fedjax.aggregators
module
fedjax.algorithms
module
fedjax.algorithms.agnostic_fed_avg
module
fedjax.algorithms.fed_avg
module
fedjax.algorithms.hyp_cluster
module
fedjax.algorithms.mime
module
fedjax.algorithms.mime_lite
module
fedjax.core.client_datasets
module
fedjax.datasets
module
fedjax.datasets.cifar100
module
fedjax.datasets.emnist
module
fedjax.datasets.shakespeare
module
fedjax.datasets.stackoverflow
module
fedjax.metrics
module
fedjax.models
module
fedjax.models.emnist
module
fedjax.models.shakespeare
module
fedjax.models.stackoverflow
module
fedjax.models.toy_regression
module
fedjax.optimizers
module
fedjax.training
module
fedjax.training.structured_flags
module
fedjax.training.tasks
module
fedjax.tree_util
module
for_each_client() (in module fedjax)
for_each_client_backend() (in module fedjax)
G
get() (fedjax.training.structured_flags.OptimizerFlags method)
get_client() (fedjax.FederatedData method)
get_clients() (fedjax.FederatedData method)
get_task() (in module fedjax.training)
grad() (in module fedjax)
H
hyp_cluster() (in module fedjax.algorithms.hyp_cluster)
HypClusterEvaluator (class in fedjax.algorithms.hyp_cluster)
I
ignore_grads_haiku() (in module fedjax.optimizers)
init (fedjax.aggregators.Aggregator attribute)
(fedjax.FederatedAlgorithm attribute)
(fedjax.Model attribute)
(fedjax.optimizers.Optimizer attribute)
InMemoryFederatedData (class in fedjax)
K
k (fedjax.metrics.SequenceTokenTopKAccuracy attribute)
(fedjax.metrics.TopKAccuracy attribute)
kmeans_init() (in module fedjax.algorithms.hyp_cluster)
L
load_data() (in module fedjax.datasets.cifar100)
(in module fedjax.datasets.emnist)
(in module fedjax.datasets.shakespeare)
(in module fedjax.datasets.stackoverflow)
load_latest_checkpoint() (in module fedjax.training)
load_split() (in module fedjax.datasets.cifar100)
(in module fedjax.datasets.emnist)
(in module fedjax.datasets.shakespeare)
(in module fedjax.datasets.stackoverflow)
log() (fedjax.training.Logger method)
Logger (class in fedjax.training)
logits_mask (fedjax.metrics.SequenceTokenAccuracy attribute)
(fedjax.metrics.SequenceTokenTopKAccuracy attribute)
M
masked_target_values (fedjax.metrics.SequenceCount attribute)
(fedjax.metrics.SequenceCrossEntropyLoss attribute)
(fedjax.metrics.SequenceLength attribute)
(fedjax.metrics.SequenceTokenAccuracy attribute)
(fedjax.metrics.SequenceTokenCount attribute)
(fedjax.metrics.SequenceTokenCrossEntropyLoss attribute)
(fedjax.metrics.SequenceTokenOOVRate attribute)
(fedjax.metrics.SequenceTokenTopKAccuracy attribute)
(fedjax.metrics.SequenceTruncationRate attribute)
mean_aggregator() (in module fedjax.aggregators)
MeanStat (class in fedjax.metrics)
merge() (fedjax.metrics.Stat method)
Metric (class in fedjax.metrics)
mime() (in module fedjax.algorithms.mime)
mime_lite() (in module fedjax.algorithms.mime_lite)
Model (class in fedjax)
model_grad() (in module fedjax)
model_per_example_loss() (in module fedjax)
ModelEvaluator (class in fedjax)
ModelFullEvaluationFn (class in fedjax.training)
ModelKMeansInitializer (class in fedjax.algorithms.hyp_cluster)
ModelSampleClientsEvaluationFn (class in fedjax.training)
ModelTrainClientsEvaluationFn (class in fedjax.training)
module
fedjax
fedjax.aggregators
fedjax.algorithms
fedjax.algorithms.agnostic_fed_avg
fedjax.algorithms.fed_avg
fedjax.algorithms.hyp_cluster
fedjax.algorithms.mime
fedjax.algorithms.mime_lite
fedjax.core.client_datasets
fedjax.datasets
fedjax.datasets.cifar100
fedjax.datasets.emnist
fedjax.datasets.shakespeare
fedjax.datasets.stackoverflow
fedjax.metrics
fedjax.models
fedjax.models.emnist
fedjax.models.shakespeare
fedjax.models.stackoverflow
fedjax.models.toy_regression
fedjax.optimizers
fedjax.training
fedjax.training.structured_flags
fedjax.training.tasks
fedjax.tree_util
N
NamedFlags (class in fedjax.training.structured_flags)
new() (fedjax.metrics.MeanStat class method)
(fedjax.metrics.SumStat class method)
(fedjax.SQLiteFederatedData static method)
num_classes (fedjax.metrics.ConfusionMatrix attribute)
num_clients() (fedjax.FederatedData method)
O
oov_target_values (fedjax.metrics.SequenceTokenOOVRate attribute)
opt_state (fedjax.algorithms.agnostic_fed_avg.ServerState attribute)
(fedjax.algorithms.fed_avg.ServerState attribute)
(fedjax.algorithms.mime.ServerState attribute)
opt_states (fedjax.algorithms.hyp_cluster.ServerState attribute)
Optimizer (class in fedjax.optimizers)
OptimizerFlags (class in fedjax.training.structured_flags)
P
padded_batch() (fedjax.ClientDataset method)
padded_batch_client_datasets() (in module fedjax)
padded_batch_federated_data() (in module fedjax)
PaddedBatchHParamsFlags (class in fedjax.training.structured_flags)
params (fedjax.algorithms.agnostic_fed_avg.ServerState attribute)
(fedjax.algorithms.fed_avg.ServerState attribute)
(fedjax.algorithms.mime.ServerState attribute)
per_position (fedjax.metrics.SequenceTokenAccuracy attribute)
(fedjax.metrics.SequenceTokenCrossEntropyLoss attribute)
(fedjax.metrics.SequenceTokenOOVRate attribute)
(fedjax.metrics.SequenceTokenTopKAccuracy attribute)
PerDomainMetric (class in fedjax.metrics)
pred_key (fedjax.metrics.Accuracy attribute)
(fedjax.metrics.ConfusionMatrix attribute)
(fedjax.metrics.CrossEntropyLoss attribute)
(fedjax.metrics.SequenceCrossEntropyLoss attribute)
(fedjax.metrics.SequenceTokenAccuracy attribute)
(fedjax.metrics.SequenceTokenCrossEntropyLoss attribute)
(fedjax.metrics.SequenceTokenTopKAccuracy attribute)
(fedjax.metrics.TopKAccuracy attribute)
preprocess_batch() (fedjax.FederatedData method)
preprocess_client() (fedjax.FederatedData method)
(in module fedjax.datasets.shakespeare)
preprocess_image() (in module fedjax.datasets.cifar100)
R
random_init() (in module fedjax.algorithms.hyp_cluster)
reduce() (fedjax.metrics.Stat method)
RepeatableIterator (class in fedjax)
replace() (fedjax.algorithms.agnostic_fed_avg.ServerState method)
(fedjax.algorithms.fed_avg.ServerState method)
(fedjax.algorithms.hyp_cluster.ServerState method)
(fedjax.algorithms.mime.ServerState method)
result() (fedjax.metrics.Stat method)
rmsprop() (in module fedjax.optimizers)
run_federated_experiment() (in module fedjax.training)
S
save_checkpoint() (in module fedjax.training)
SequenceCount (class in fedjax.metrics)
SequenceCrossEntropyLoss (class in fedjax.metrics)
SequenceLength (class in fedjax.metrics)
SequenceTokenAccuracy (class in fedjax.metrics)
SequenceTokenCount (class in fedjax.metrics)
SequenceTokenCrossEntropyLoss (class in fedjax.metrics)
SequenceTokenOOVRate (class in fedjax.metrics)
SequenceTokenTopKAccuracy (class in fedjax.metrics)
SequenceTruncationRate (class in fedjax.metrics)
ServerState (class in fedjax.algorithms.agnostic_fed_avg)
(class in fedjax.algorithms.fed_avg)
(class in fedjax.algorithms.hyp_cluster)
(class in fedjax.algorithms.mime)
set_for_each_client_backend() (in module fedjax)
set_tf_cpu_only() (in module fedjax.training)
sgd() (in module fedjax.optimizers)
shuffle_repeat_batch() (fedjax.ClientDataset method)
shuffle_repeat_batch_federated_data() (in module fedjax)
shuffled_clients() (fedjax.FederatedData method)
ShuffleRepeatBatchHParamsFlags (class in fedjax.training.structured_flags)
slice() (fedjax.FederatedData method)
SQLiteFederatedData (class in fedjax)
SQLiteFederatedDataBuilder (class in fedjax)
StackoverflowTokenizer (class in fedjax.datasets.stackoverflow)
Stat (class in fedjax.metrics)
SubsetFederatedData (class in fedjax)
SumStat (class in fedjax.metrics)
T
target_key (fedjax.metrics.Accuracy attribute)
(fedjax.metrics.ConfusionMatrix attribute)
(fedjax.metrics.CrossEntropyLoss attribute)
(fedjax.metrics.SequenceCount attribute)
(fedjax.metrics.SequenceCrossEntropyLoss attribute)
(fedjax.metrics.SequenceLength attribute)
(fedjax.metrics.SequenceTokenAccuracy attribute)
(fedjax.metrics.SequenceTokenCount attribute)
(fedjax.metrics.SequenceTokenCrossEntropyLoss attribute)
(fedjax.metrics.SequenceTokenOOVRate attribute)
(fedjax.metrics.SequenceTokenTopKAccuracy attribute)
(fedjax.metrics.SequenceTruncationRate attribute)
(fedjax.metrics.TopKAccuracy attribute)
TaskFlags (class in fedjax.training.structured_flags)
TopKAccuracy (class in fedjax.metrics)
train_loss (fedjax.Model attribute)
TrainClientsEvaluationFn (class in fedjax.training)
tree_add() (in module fedjax.tree_util)
tree_clip_by_global_norm() (in module fedjax.tree_util)
tree_inverse_weight() (in module fedjax.tree_util)
tree_l2_norm() (in module fedjax.tree_util)
tree_mean() (in module fedjax.tree_util)
tree_size() (in module fedjax.tree_util)
tree_sum() (in module fedjax.tree_util)
tree_weight() (in module fedjax.tree_util)
tree_zeros_like() (in module fedjax.tree_util)
U
uniform_stochastic_quantizer() (in module fedjax.aggregators)
unreduced_cross_entropy_loss() (in module fedjax.metrics)
W
weight (fedjax.metrics.MeanStat attribute)
Z
zero() (fedjax.metrics.Metric method)
Read the Docs
v: latest
Versions
latest
stable
Downloads
html
On Read the Docs
Project Home
Builds