Skip to content

Commit

Permalink
docs(readme): update documentation according the newly added linear1d…
Browse files Browse the repository at this point in the history
… layer
  • Loading branch information
julianhoever committed Aug 19, 2022
1 parent 83b9e6b commit 41e2486
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ VHDLComponent <|.. VHDLStaticComponent
VHDLComponent <|.. SigmoidComponent
VHDLComponent <|.. TanhComponent
VHDLComponent <|.. RomComponent
VHDLComponent <|.. Linear1dComponent
VHDLStaticComponent <|-- LSTMComponent
VHDLStaticComponent <|-- LSTMCommonComponent
VHDLStaticComponent <|-- DualPort2ClockRamComponent
Expand All @@ -78,28 +79,41 @@ translated is represented as translatable. A `Translatable` class has a `transla
DTO (Data Transfer Object) which receives all necessary parameters from the user to translate the layer to VHDL and
returns a `VHDLModule` as the result of the translation.

An incomplete class diagram showing this for the `AbstractLSTM` layer is the following:
An incomplete class diagram showing this for the `LSTMTranslatable` and `Linear1dTranslatable` is the following:

```mermaid
classDiagram
class Translatable {
<<interface>>
+translate(Any args) VHDLModule
}
class LSTMTranslatable {
+weights_ih
+weights_hh
+biases_ih
+biases_hh
+translate(LSTMTranslationArguments args) VHDLModule
+translate(LSTMTranslationArgs args) VHDLModule
}
class LSTMTranslationArgs {
+fixed_point_factory
+sigmoid_resolution
+tanh_resolution
}
class Linear1dTranslatable {
+weight
+bias
+translate(Linear1dTranslationArgs args) VHDLModule
}
class Linear1dTranslationArgs {
+fixed_point_factory
}
Translatable <|.. LSTMTranslatable
LSTMTranslatable -- LSTMTranslationArgs
Translatable <|.. Linear1dTranslatable
Linear1dTranslatable -- Linear1dTranslationArgs
```

#### Build Functions
Expand Down

0 comments on commit 41e2486

Please sign in to comment.