Skip to content

update CLI arguments doc following the code #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amitport wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update CLI arguments doc following the code #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions optimization/docs/hyperparameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ used when running experiments in

**Cross-task hyperparameters**

Hyperparameter | Flag | Value
--------------------------- | ---------------------- | ---------------
Number of clients per round | `clients_per_round` | See table below
Number of client epochs | `client_epochs` | 1
Client sampling seed | `client_datasets_seed` | 1
Total rounds | `total_rounds` | See table below
Batch size | `client_batch_size` | See table below
Hyperparameter | Flag | Value
--------------------------- | ----------------------------- | ---------------
Number of clients per round | `clients_per_round` | See table below
Number of client epochs | `client_epochs_per_round` | 1
Client sampling seed | `client_datasets_random_seed` | 1
Total rounds | `total_rounds` | See table below
Batch size | `client_batch_size` | See table below

**Default values**

Expand All @@ -47,15 +47,16 @@ Next, we list task-specific hyperparameters, and the suggested starting values

**CIFAR-100 Image Classification**

Hyperparameter | Flag | Value
--------------- | -------------------------- | -----
Image crop size | `cifar100_image_crop_size` | 24
Hyperparameter | Flag | Value
----------------- | ---------------------------- | -----
Image crop width | `cifar100_image_crop_width` | 24
Image crop height | `cifar100_image_crop_height` | 24

**EMNIST Character Recognition**

Hyperparameter | Flag | Value
-------------- | ------------------------ | -----
Model type | `emnist_character_model` | cnn
Hyperparameter | Flag | Value
-------------- | --------------------------- | -----
Model type | `emnist_character_model_id` | cnn

**Shakespeare Character Prediction**

Expand All @@ -70,7 +71,7 @@ Hyperparameter | Flag | Value
Vocabulary size | `stackoverflow_word_vocab_size` | 10000
Sequence length | `stackoverflow_word_sequence_length` | 20
Validation set size | `num_validation_examples` | 10000
Max examples per client | `max_elements_per_user` | 1000
Max examples per client | `max_elements_per_client` | 1000

**Stack Overflow TP**

Expand All @@ -79,7 +80,7 @@ Hyperparameter | Flag | Value
Vocabulary size | `stackoverflow_tag_word_vocab_size` | 10000
Number of labels | `stackoverflow_tag_tag_vocab_size` | 500
Validation set size | `num_validation_examples` | 10000
Max examples per client | `max_elements_per_user` | 1000
Max examples per client | `max_elements_per_client` | 1000

## Configuring optimizers

Expand Down