https://github.com/liulietlee/nn
A toy convolutional neural network framework, written by Swift and Metal, for iOS and macOS
https://github.com/liulietlee/nn
convolutional-neural-network cs231n ios macos metal neural-network swift
Last synced: 2 months ago
JSON representation
A toy convolutional neural network framework, written by Swift and Metal, for iOS and macOS
- Host: GitHub
- URL: https://github.com/liulietlee/nn
- Owner: LiulietLee
- License: mit
- Created: 2019-11-02T13:11:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-07T16:01:17.000Z (over 5 years ago)
- Last Synced: 2025-01-20T08:28:25.168Z (4 months ago)
- Topics: convolutional-neural-network, cs231n, ios, macos, metal, neural-network, swift
- Language: Swift
- Homepage:
- Size: 1.42 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nn
> A toy convolutional neural network framework, written by Swift and Metal, for iOS and macOS devices.
## Usage
### Train a handwritten digit classifier
### On [macOS](https://github.com/LiulietLee/nn/tree/master/Example/mnist-mac)
1. Donwload MNIST dataset
```
curl -O http://yann.lecun.com/exdb/mnist/train-images-idx3-ubyte.gz
curl -O http://yann.lecun.com/exdb/mnist/train-labels-idx1-ubyte.gz
curl -O http://yann.lecun.com/exdb/mnist/t10k-images-idx3-ubyte.gz
curl -O http://yann.lecun.com/exdb/mnist/t10k-labels-idx1-ubyte.gz
gunzip t*-ubyte.gz
```
2. Define a network
```swift
let net = Sequential([
Conv(3, count: 3, padding: 1),
Conv(3, count: 3, padding: 1),
Conv(3, count: 3, padding: 1),
ReLU(),
MaxPool(2, step: 2),
Conv(3, count: 6, padding: 1),
Conv(3, count: 6, padding: 1),
Conv(3, count: 6, padding: 1),
ReLU(),
MaxPool(2, step: 2),
Dense(inFeatures: 6 * 7 * 7, outFeatures: 120),
Dense(inFeatures: 120, outFeatures: 10)
])
```
3. Create a data reader
```swift
let reader = MNISTReader(
root: "/.../mnist", // path to your dataset
batchSize: 64
)
```
4. Use GPU (or the computation will be extremely slow)
```swift
Core.device = MTLCreateSystemDefaultDevice()
```
5. Train
```swift
func train() {
ModelStorage.load(net, path: "mnistmodel01.nnm")
for i in 0..<3 {
var j = 0
var runningLoss: Float = 0.0
while let (img, label) = reader.nextTrain() {
net.zeroGrad()
let _ = net.forward(img)
let loss = net.loss(label)
net.backward(label)
net.step(lr: 0.0001, momentum: 0.99)
runningLoss = max(runningLoss, loss)
if j % 100 == 99 {
print("[\(i), \(j)] loss: \(runningLoss)")
runningLoss = 0.0
ModelStorage.save(net, path: "mnistmodel01.nnm")
}
j += 1
}
}
ModelStorage.save(net, path: "mnistmodel01.nnm")
}
train()
```
It's very easy to understand the `train()` function if you have used PyTorch.
Total training time is about 24 minutes on my computer (MacBook Pro Retina, 13-inch, Mid 2014)
Maybe you think that it's very slow.
Yes. So it's recommended to start training before you having lunch.
6. Test
```swift
func test() {
ModelStorage.load(net, path: "mnistmodel01.nnm")
var cor = 0
var tot = 0
while let (img, label) = reader.nextTest() {
let score = net.forward(img)
let pred = score.indexOfMax()
if pred == label {
cor += 1
print("\(tot): Y \(pred) == \(label)")
} else {
print("\(tot): N \(pred) != \(label)")
}
tot += 1
}
print("correct: \(cor) / \(tot)")
}
test()
```
Since we only trained for three epochs, the accuracy rate won't be very high (about 86%).
If you wanna improve it, you can train more epochs.
### On [iOS](https://github.com/LiulietLee/nn/tree/master/Example/mnist-ios)
1. Move pretrained model [mnistmodel01.nnm](https://github.com/LiulietLee/nn/blob/master/Example/mnist-ios/mnist-ios/mnistmodel01.nnm) file to your iOS project. Make sure the **Target Membership** is selected.
2. Create a model with the same structure as before.
```swift
let model = Sequential([
Conv(3, count: 3, padding: 1),
...
Dense(inFeatures: 120, outFeatures: 10)
])
```
3. Load model parameters and enable GPU computation in `viewDidLoad()`.
```swift
override func viewDidLoad() {
super.viewDidLoad()
let path = Bundle.main.path(forResource: "mnistmodel01", ofType: "nnm")!
ModelStorage.load(model, path: path)
Core.device = MTLCreateSystemDefaultDevice()
}
```
4. Use `forward()` function to predict.
```swift
@IBAction func check() {
let img = getViewImage() // this function convert UIView to NNArray
let res = model.forward(img)
let pred = res.indexOfMax()
button.setTitle("\(pred)", for: .normal)
}
```
You can read the [source](https://github.com/LiulietLee/nn/blob/master/Example/mnist-ios/mnist-ios/ViewController.swift) for detail.
## Avaliable Layer
- Conv (2D convolutional layer)
- Dense (fully connected layer)
- ReLU (leaky relu)
- MaxPool (2D max pooling layer)
- AveragePool (2D average pooling layer (uncompleted ver.))