Skip to content

Commit

Permalink
Add Docs for profiler
Browse files Browse the repository at this point in the history
  • Loading branch information
ncassereau committed Aug 4, 2023
1 parent 6b7fe82 commit 6bb226e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/Train/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Options shared for all values of `NETWORK_TASK` are organized in groups:
- **Cross-validation arguments**
- `--n_splits` (int) is a number of splits k to load in the case of a k-fold cross-validation. Default will load a single-split.
- `--split` (list of int) is a subset of folds that will be used for training. By default all splits available are used.
- **Reproducibility** (for more information refer to the [implementation details](./Details.md#deterministic-algorithms)
- **Reproducibility** (for more information refer to the [implementation details](./Details.md#deterministic-algorithms))
- `--seed` (int) is the value used to set the seed of all random operations. Default samples a seed and uses it for the experiment.
- `--nondeterministic/--deterministic` (bool) forces the training process to be deterministic.
If any non-deterministic behaviour is encountered will raise a RuntimeError. Default: `--nondeterministic`.
Expand All @@ -99,6 +99,8 @@ Options shared for all values of `NETWORK_TASK` are organized in groups:
- `--tolerance` (float) is the value used for [early stopping](Details.md#stopping-criterion) tolerance. Default: `0`.
- `--accumulation_steps` (int) gives the number of iterations during which gradients are accumulated before performing the [weights update](Details.md#optimization).
This allows to virtually increase the size of the batch. Default: `1`.
- `--profiler/--no-profiler` (bool) Enables Pytorch profiler for the first 30 steps after a short warmup. It will make an execution trace in the output directory and some statistics about the CPU and GPU usage. Default: `False`.

- **Transfer learning parameters**
- `--transfer_path` (Path) is the path to the model used for transfer learning.
- `--transfer_selection_metric` (str) is the transfer learning selection metric.
Expand Down

0 comments on commit 6bb226e

Please sign in to comment.