Skip to content

Commit bc40df3

Browse files
authored
Small formatting improvements
1 parent 4ae089c commit bc40df3

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
![](http://i.pi.gy/8ZDDE.png)
22

33
# What is it?
4+
45
**NeuralNetwork.NET** is a .NET Standard 2.0 library that implements a Convolutional Neural Network with customizable layers, built from scratch with C#.
56
It provides simple APIs to define a CNN structure and to train the network using Stochastic Gradient Descent, as well as methods to save/load a network and its metadata and more.
67

@@ -28,10 +29,10 @@ More details available [here](https://www.nuget.org/packages/NeuralNetwork.NET/)
2829

2930
# Quick start
3031

31-
### Supervised learning
32-
3332
The **NeuralNetwork.NET** library exposes easy to use classes and methods to create a new neural network, prepare the datasets to use and train the network. These APIs are designed for rapid prototyping, and this section provides an overview of the required steps to get started.
3433

34+
## Supervised learning
35+
3536
The first step is to create a custom network structure. Here is an example with a sequential network (a stack of layers):
3637

3738
```C#
@@ -77,7 +78,7 @@ TrainingSessionResult result = NetworkManager.TrainNetwork(network,
7778

7879
**Note:** the `NetworkManager` methods are also available as asynchronous APIs.
7980

80-
### GPU acceleration
81+
## GPU acceleration
8182

8283
When running on a supported framework (.NET Framework, Xamarin or Mono), it is possible to use a different implementation of the available layers that leverages the cuDNN toolkit and parallelizes most of the work on the available CUDA-enabled GPU. To do that, just use the layers from the `CuDnnNetworkLayers` class when creating a network.
8384

@@ -101,7 +102,7 @@ These `LayerFactory` instances can be used to create a new network just like in
101102

102103
**NOTE:** in order to use this feature, the CUDA and cuDNN toolkits must be installed on the current system, a CUDA-enabled nVidia GeForce/Quadro GPU must be available and the **Alea** NuGet package must be installed in the application using the **NeuralNetwork.NET** library as well. Additional info are available [here](http://www.aleagpu.com/release/3_0_4/doc/installation.html#deployment_considerations).
103104
104-
### Library settings
105+
## Library settings
105106

106107
**NeuralNetwork.NET** provides various shared settings that are available through the `NetworkSettings` class.
107108
This class acts as a container to quickly check and modify any setting at any time, and these settings will influence the behavior of any existing `INeuralNetwork` instance and the library in general.
@@ -120,7 +121,7 @@ To avoid memory issues, it is possible to modify this behavior:
120121
NetworkSettings.MaximumBatchSize = 400; // This will apply to any test or validation dataset
121122
```
122123

123-
### Serialization and deserialization
124+
## Serialization and deserialization
124125

125126
The `INeuralNetwork` interface exposes a `Save` method that can be used to serialize any network at any given time.
126127
In order to get a new network instance from a saved file or stream, just use the `NetworkLoader.TryLoad` method.

0 commit comments

Comments
 (0)