add license and readme

This commit is contained in:
markichnich 2024-03-21 22:17:40 +01:00
parent 562613ad4b
commit f722c55100
2 changed files with 49 additions and 0 deletions

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# aicaramba ✨
a simple neural network implementation from a perspective of linear algebra.
the library is mostly developed for recreational and educational purposes for myself
and only depends on the `rand`-crate for randomization of newly created weight-
and bias matrices.
for a usage example see `src/bin/xor.rs`, which simulates an XOR-logic-gate using
a small neural network.
---
## features
currently available features of the library:
- ReLU and Sigmoid activation functions
- the MSE loss function
- a single, down-to-earth struct that contains the whole network
## roadmap
what might happen down the road:
- BCE loss function (requires output layer sigmoid activation - not a trivial addition)
- serde (de-)serialization to easily store checkpoints/training progress.
- perhaps a MNIST example (?)