Skip to content

Commit

Permalink
docs: start glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
glencoe committed Aug 25, 2023
1 parent cf4f1d5 commit b2d82cd
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,16 @@ All packages and modules fall into one of five main categories and can thus be f
- `file_generation`: provide a very restricted api to generate files or file subtrees under a given root node and defines a basic template api and datastructure, compatible with `file_generation`


### Glossary

- **fxp/Fxp**: prefix for fixed point
- **flp/Flp**: prefix for floating point
- **x**: parameter input tensor for layer with single input tensor
- **y**: output value/tensor for layer with single output
- **_bits**: suffix to denote the number of bits, e.g. `total_bits`, `frac_bits`, in python context
- **_width**: suffix to denote the number of bits used for a data bus in vhdl, e.g. `total_width`, `frac_width`


### Conventional Commit Rules

We use conventional commits (see [here](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary)). The following commit types and message scopes are allowed. The message scope is optional.
Expand Down

0 comments on commit b2d82cd

Please sign in to comment.