Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinMusgrave committed May 15, 2020
1 parent e87bce1 commit d1e11fb
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/testers.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ testers.BaseTester(reference_set="compared_to_self",
* label: The corresponding labels for each embedding.
* split_name: The name of the split (train, val, etc.)
* keyname: The name of the dictionary key where the embeddings and labels are stored. (The dictionary is self.dim_reduced_embeddings[split_name][keyname].)
* epoch: The epoch for which the embeddings are being computed.


## GlobalEmbeddingSpaceTester
Expand Down
2 changes: 2 additions & 0 deletions docs/trainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ trainers.BaseTrainer(models,
collate_fn=None,
lr_schedulers=None,
gradient_clippers=None,
freeze_these=(),
freeze_trunk_batchnorm=False,
label_hierarchy_level=0,
dataloader_num_workers=32,
Expand Down Expand Up @@ -67,6 +68,7 @@ If not specified, then the original labels are used.
* ```metric_loss_scheduler_by_epoch```
* ```embedder_scheduler_by_plateau```
* **gradient_clippers**: A dictionary of gradient clipping functions. Each function will be called before the optimizers.
* **freeze_these**: Optional. A list or tuple of the names of models or loss functions that should have their parameters frozen during training. These models will have ```requires_grad``` set to False, and their optimizers will not be stepped.
* **freeze_trunk_batchnorm**: If True, then the BatchNorm parameters of the trunk model will be frozen during training.
* **label_hierarchy_level**: If each sample in your dataset has multiple labels, then this integer argument can be used to select which "level" to use. This assumes that your labels are "2-dimensional" with shape (num_samples, num_hierarchy_levels). Leave this at the default value, 0, if your data does not have multiple labels per sample.
* **dataloader_num_workers**: The number of processes your dataloader will use to load data.
Expand Down

0 comments on commit d1e11fb

Please sign in to comment.