mininn 0.1.4

A minimalist deep learnig crate for rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# Contributing to MiniNN

>[!NOTE]
> This started as a personal project so probably there are some things that can be improved, I'm new to open source projects and I'm not sure if I'm doing the right things, so if you see something that can be improved, feel free to open an issue or a pull request.

Thank you for your interest in contributing to **MiniNN**! Your support, whether through bug reports, feature suggestions, or documentation improvements, is greatly appreciated.

## How to contribute

There are several ways you can contribute to the project:

- **Reporting bugs**
- **Implementing features in the [TODO](TODO.md) list**
- **Suggesting new features**
- **Improving documentation**
- **Submitting pull requests**

## Development Setup

To set up the project locally for development, follow these steps:

1. Clone the repository:

    ```bash
    git clone --depth 1 https://github.com/Pacatro/mininn.git
    ```

2. Install dependencies and set up the environment, there is a `makefile` that can be used for this:

    ```bash
    cd mininn
    make
    ```

3. Run the tests to make sure everything is working:

    ```bash
    cargo test
    ```

## Style Guidelines

- **Code formatting**: Please use the `rustfmt` tool to format your code.

    ```bash
    cargo fmt
    ```

- **Documentation**: Ensure that your code is well-documented, including doc comments for public functions, structs, and methods. You can check the documentation for the project by running:

    ```bash
    cargo doc --open
    ```

- **Testing**: Write tests for new features and bug fixes. Run tests locally before submitting a pull request.