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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
use std::{
fs::File,
io::{Read, Write},
process::{ExitCode, Termination},
};
use crate::{activationfn::ActivationFn, edge::Edge, layer::LayerID, node::Node};
use anyhow::{ensure, Context, Result};
use serde::{Deserialize, Serialize};
/// A neural network. Interact with this struct to create and modify your network.
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct Network {
pub(crate) nodes: Vec<Node>,
pub(crate) edges: Vec<Edge>,
pub(crate) layers: Vec<LayerID>,
pub(crate) fitness: Option<f64>,
pub(crate) activation_fn: ActivationFn,
}
impl Network {
pub(crate) fn get_node(&self, node_id: usize) -> Option<&Node> {
self.nodes.iter().find(|node| node.id == node_id)
}
pub(crate) fn get_node_mut(&mut self, node_id: usize) -> Option<&mut Node> {
self.nodes.iter_mut().find(|node| node.id == node_id)
}
pub(crate) fn get_layer(&self, layer_id: LayerID) -> Option<Vec<&Node>> {
let matches = self
.nodes
.iter()
.filter(|node| node.layer_id == layer_id)
.collect::<Vec<&Node>>();
if !self.layers.contains(&layer_id) {
None
} else {
Some(matches)
}
}
pub(crate) fn get_layer_mut(&mut self, layer_id: LayerID) -> Option<Vec<&mut Node>> {
let matches = self
.nodes
.iter_mut()
.filter(|node| node.layer_id == layer_id)
.collect::<Vec<&mut Node>>();
if !self.layers.contains(&layer_id) {
None
} else {
Some(matches)
}
}
pub(crate) fn get_edge(&self, edge_id: usize) -> Option<&Edge> {
self.edges.iter().find(|edge| edge.id == edge_id)
}
/// Runs the inputs of the network.
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// # let mut network = Network::create(1, 1, ActivationFn::Sigmoid).unwrap();
/// # let layerid = network.add_layer();
/// # let input_node_id = network.input_node_ids().pop().unwrap();
/// # let hidden_node_id = Node::create(&mut network, layerid, 0.0).unwrap();
/// # let output_node_id = network.output_node_ids().pop().unwrap();
/// # Edge::create(&mut network, input_node_id, hidden_node_id, 0.5).unwrap();
/// # Edge::create(&mut network, hidden_node_id, output_node_id, 0.5).unwrap();
/// let mut output = vec![];
/// network.fire(vec![0.8], &mut output).unwrap();
/// ```
pub fn fire(&mut self, inputs: Vec<f64>, outputs: &mut Vec<f64>) -> Result<()> {
ensure!(
self.nodes
.iter()
.filter(|node| node.layer_id == LayerID::InputLayer)
.count()
== inputs.len(),
"Number of inputs does not match number of input nodes"
);
for (node, input) in self
.nodes
.iter_mut()
.filter(|node| node.layer_id == LayerID::InputLayer)
.zip(inputs)
{
node.value = input;
}
for layer_id in self.layers.clone().iter() {
self.fire_layer(*layer_id)?;
}
let output_layer = self
.get_layer(LayerID::OutputLayer)
.context("Output layer does not exist")?
.iter()
.map(|node| node.value)
.collect::<Vec<f64>>();
outputs.clear();
outputs.extend(output_layer);
// clear all node's `value` fields
for node in self.nodes.iter_mut() {
node.reset();
}
Ok(())
}
pub(crate) fn fire_layer(&mut self, id: LayerID) -> Result<()> {
let ids = self
.clone()
.get_layer_mut(id)
.context("Layer does not exist")?
.iter()
.map(|node| node.id)
.collect::<Vec<usize>>();
let mut edges = Vec::new();
for id in ids {
for edge in self
.clone()
.edges
.iter()
.filter(|edge| edge.node_from_id == id)
{
edges.push((
edge.clone().node_from_id,
edge.clone().node_to_id,
edge.clone().weight,
))
}
}
for (node_from_id, node_to_id, edge_weight) in edges {
let node_from_value = self
.get_node(node_from_id)
.context("Node from does not exist")?
.value;
let node_to = self
.get_node_mut(node_to_id)
.context("Node to does not exist")?;
node_to.add_value(node_from_value * edge_weight);
}
// get the next layer's id
let mut next_layer = match id {
LayerID::InputLayer => LayerID::HiddenLayer(0),
LayerID::HiddenLayer(id) => LayerID::HiddenLayer(id + 1),
LayerID::OutputLayer => LayerID::OutputLayer,
};
if !self.layers.contains(&next_layer) {
next_layer = LayerID::OutputLayer;
}
let mut layer = self
.get_layer_mut(next_layer)
.context("Layer does not exist")?;
let nodes = layer
.iter_mut()
.filter(|node| node.layer_id == next_layer)
.collect::<Vec<&mut &mut Node>>();
for node in nodes {
node.add_value(node.bias);
node.value = node.activation_fn.run(node.value);
}
Ok(())
}
/// Adds the next available layer.
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, layer::LayerID, activationfn::ActivationFn};
/// # let mut network = Network::create(1, 1, ActivationFn::Sigmoid).unwrap();
/// let layer_id: LayerID = network.add_layer();
/// ```
pub fn add_layer(&mut self) -> LayerID {
let mut hidden_layers = self
.layers
.iter()
.filter(|layer| matches!(layer, LayerID::HiddenLayer(_)))
.collect::<Vec<&LayerID>>();
hidden_layers.sort();
let next_layer = match hidden_layers.last() {
Some(layer) => match layer {
LayerID::HiddenLayer(id) => LayerID::HiddenLayer(id + 1),
_ => unreachable!(),
},
None => LayerID::HiddenLayer(0),
};
self.layers.push(next_layer);
next_layer
}
/// Serialize the network to a string
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// # let mut network = Network::create(1, 1, ActivationFn::Sigmoid).unwrap();
/// # let layerid = network.add_layer();
/// # let input_node_id = network.input_node_ids().pop().unwrap();
/// # let hidden_node_id = Node::create(&mut network, layerid, 0.0).unwrap();
/// # let output_node_id = network.output_node_ids().pop().unwrap();
/// # Edge::create(&mut network, input_node_id, hidden_node_id, 0.5).unwrap();
/// # Edge::create(&mut network, hidden_node_id, output_node_id, 0.5).unwrap();
/// let string = network.serialize().unwrap();
/// ```
pub fn serialize(&self) -> Result<String> {
serde_json::to_string(&self).context("Could not serialize network")
}
/// Deserialize a network from a string
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// # let mut network = Network::create(1, 1, ActivationFn::Sigmoid).unwrap();
/// # let layer_id = network.add_layer();
/// # let input_node_id = network.input_node_ids().pop().unwrap();
/// # let hidden_node_id = Node::create(&mut network, LayerID::HiddenLayer(0), 0.0).unwrap();
/// # let output_node_id = network.output_node_ids().pop().unwrap();
/// # Edge::create(&mut network, input_node_id, hidden_node_id, 0.5).unwrap();
/// # Edge::create(&mut network, hidden_node_id, output_node_id, 0.5).unwrap();
/// let string = network.serialize().unwrap();
/// let mut network2 = Network::deserialized(&string).unwrap();
///
/// let mut outs = Vec::new();
/// let mut outs2 = Vec::new();
///
/// network.fire(vec![0.8], &mut outs).unwrap();
/// network2.fire(vec![0.8], &mut outs2).unwrap();
///
/// assert_eq!(outs, outs2);
/// ```
pub fn deserialized(string: &str) -> Result<Self> {
serde_json::from_str(string).context("Could not deserialize network")
}
/// Serialize the network to a file
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// # let mut network = Network::create(1, 1, ActivationFn::Sigmoid).unwrap();
/// # let layerid = network.add_layer();
/// # let input_node_id = network.input_node_ids().pop().unwrap();
/// # let hidden_node_id = Node::create(&mut network, layerid, 0.0).unwrap();
/// # let output_node_id = network.output_node_ids().pop().unwrap();
/// # Edge::create(&mut network, input_node_id, hidden_node_id, 0.5).unwrap();
/// # Edge::create(&mut network, hidden_node_id, output_node_id, 0.5).unwrap();
/// network.save("network.json").unwrap();
/// ```
pub fn save(&self, path: &str) -> Result<()> {
let mut file = File::create(path).context("Could not create file")?;
file.write_all(self.serialize()?.as_bytes())
.context("Could not write to file")?;
Ok(())
}
/// Deserialize a network from a file
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// # let mut network = Network::create(1, 1, ActivationFn::Sigmoid).unwrap();
/// # let layerid = network.add_layer();
/// # let input_node_id = network.input_node_ids().pop().unwrap();
/// # let hidden_node_id = Node::create(&mut network, layerid, 0.0).unwrap();
/// # let output_node_id = network.output_node_ids().pop().unwrap();
/// # Edge::create(&mut network, input_node_id, hidden_node_id, 0.5).unwrap();
/// # Edge::create(&mut network, hidden_node_id, output_node_id, 0.5).unwrap();
/// network.save("network.json").unwrap();
/// let mut network2 = Network::load("network.json").unwrap();
///
/// let mut outs = Vec::new();
/// let mut outs2 = Vec::new();
///
/// network.fire(vec![0.8], &mut outs).unwrap();
/// network2.fire(vec![0.8], &mut outs2).unwrap();
///
/// assert_eq!(outs, outs2);
/// ```
pub fn load(path: &str) -> Result<Self> {
let mut file = File::open(path).context("Could not open file")?;
let mut string = String::new();
file.read_to_string(&mut string)
.context("Could not read file")?;
Self::deserialized(&string)
}
/// Create a new network with the given number of inputs and outputs
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, activationfn::ActivationFn};
/// let mut network = Network::create(2, 1, ActivationFn::Linear).unwrap();
/// ```
pub fn create(input_ct: usize, output_ct: usize, activation_fn: ActivationFn) -> Result<Self> {
let mut network = Self {
edges: vec![],
nodes: vec![],
layers: vec![LayerID::InputLayer, LayerID::OutputLayer],
fitness: None,
activation_fn,
};
let mut input_ids = Vec::new();
let mut output_ids = Vec::new();
for _ in 0..input_ct {
input_ids.push(Node::create(&mut network, LayerID::InputLayer, 0.0)?);
}
for _ in 0..output_ct {
output_ids.push(Node::create(&mut network, LayerID::OutputLayer, 0.0)?);
}
Ok(network)
}
/// Get the ids of all the input nodes
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// let mut network = Network::create(1, 1, ActivationFn::Linear).unwrap();
/// let input_node_id = network.input_node_ids().pop().unwrap();
pub fn input_node_ids(&self) -> Vec<usize> {
self.nodes
.iter()
.filter(|n| n.layer_id == LayerID::InputLayer)
.map(|n| n.id)
.collect()
}
/// Get the ids of all the output nodes
///
/// ### Example
/// ```
/// # use nnrs::{network::Network, node::Node, layer::LayerID, edge::Edge, activationfn::ActivationFn};
/// let mut network = Network::create(1, 1, ActivationFn::Linear).unwrap();
/// let output_node_id = network.output_node_ids().pop().unwrap();
/// ```
pub fn output_node_ids(&self) -> Vec<usize> {
self.nodes
.iter()
.filter(|n| n.layer_id == LayerID::OutputLayer)
.map(|n| n.id)
.collect()
}
}
impl Termination for Network {
fn report(self) -> ExitCode {
0.into()
}
}