Skip to content

Commit 666f2a3

Browse files
committed
docs: update README and library documentation for new compat and CNA modules
- Added `compat` module details in README, including activation and normalization wrappers. - Documented `CNA2d` block (Conv2d + Normalization + Activation) in both README and library. - Minor adjustment to environment variables in `.run/Docs.run.xml`.
1 parent fe5de00 commit 666f2a3

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

.run/Docs.run.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<option name="workingDirectory" value="file://$PROJECT_DIR$" />
66
<envs>
77
<env name="CINIC10_PATH" value="/media/Data/CINIC-10" />
8+
<env name="DISPLAY" value=":1" />
89
</envs>
910
<option name="emulateTerminal" value="true" />
1011
<option name="channel" value="STABLE" />

crates/bimm/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,18 @@ let model: ResNet<Wgpu> = prefab
3636
```
3737

3838
* [bimm::cache](https://docs.rs/bimm/latest/bimm/cache) - weight loading cache.
39+
* [bimm::compat](https://docs.rs/bimm/latest/bimm/compat) - future-porting burn mechanisms.
40+
* [bimm::compat::activation_wrapper::Activation](https://docs.rs/bimm/latest/bimm/compat/activation_wrapper/enum.Activation.html) -
41+
activation layer abstraction wrapper.
42+
* [bimm::compat::normalization_wrapper::Normalization](https://docs.rs/bimm/latest/bimm/compat/normalization_wrapper/enum.Normalization.html) -
43+
normalization layer abstraction wrapper.
3944
* [bimm::layers](https://docs.rs/bimm/latest/bimm/layers) - reusable neural network modules.
40-
* [bimm::layers::activation](https://docs.rs/bimm/latest/bimm/layers/activation) - activation
41-
layers.
42-
* [bimm::layers::activation::Activation](https://docs.rs/bimm/latest/bimm/layers/activation/enum.Activation.html)
43-
- activation layer abstraction wrapper.
4445
* [bimm::layers::blocks](https://docs.rs/bimm/latest/bimm/layers/blocks) - miscellaneous
4546
blocks.
46-
* [bimm::layers::blocks::conv_norm](https://docs.rs/bimm/latest/bimm/layers/blocks/conv_norm) -
47+
* [bimm::layers::blocks::conv_norm::ConvNorm2d](https://docs.rs/bimm/latest/bimm/layers/blocks/conv_norm) -
4748
``Conv2d + BatchNorm2d`` block.
49+
* [bimm::layers::blocks::cna::CNA2d](https://docs.rs/bimm/latest/bimm/layers/blocks/conv_norm) -
50+
``Conv2d + Normalization + Activation`` block.
4851
* [bimm::layers::drop](https://docs.rs/bimm/latest/bimm/layers/drop) - dropout layers.
4952
* [bimm::layers::drop::drop_block](https://docs.rs/bimm/latest/bimm/layers/drop/drop_block) -
5053
2d drop

crates/bimm/src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
//! * [`compat::normalization_wrapper::Normalization`] - norm layer abstraction wrapper.
1010
//! * [`layers`] - reusable neural network modules.
1111
//! * [`layers::blocks`] - miscellaneous blocks.
12-
//! * [`layers::blocks::conv_norm`] - ``Conv2d + BatchNorm2d`` block.
12+
//! * [`layers::blocks::cna::CNA2d`] - ``Conv2d + Normalization + Activation`` block.
13+
//! * [`layers::blocks::conv_norm::ConvNorm2d`] - ``Conv2d + BatchNorm2d`` block.
1314
//! * [`layers::drop`] - dropout layers.
1415
//! * [`layers::drop::drop_block`] - 2d drop block / spatial dropout.
1516
//! * [`layers::drop::drop_path`] - drop path / stochastic depth.

0 commit comments

Comments
 (0)