Skip to content

Commit 1f69144

Browse files
committed
Improve README with optional parameters
1 parent aaf5f0f commit 1f69144

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,14 @@ optnet = require 'optnet'
6262
optnet.optimizeMemory(net, input, opts)
6363
```
6464

65+
### Optional parameters
66+
67+
Here is a list of options that are currently supported, and should be passed in the `opts` table as a third argument:
68+
* `inplace`: uses in place modules when available (boolean)
69+
* `mode`: selects between `training` and `evaluation` optimization algorithm (string)
70+
* `reuseBuffers`: shares internal buffers between same modules (like unfolded images for convolution) (boolean)
71+
* `removeGradParams`: remove `gradWeight` and `gradBias` in the networks, saving their sharings so that they can be exactly reconstructed. Only applies for `evaluation` mode (boolean)
72+
6573
## Visualizing the memory reuse
6674

6775
We can analyse the sharing of the internal buffers by looking at the computation

0 commit comments

Comments
 (0)