File tree 1 file changed +13
-0
lines changed
1 file changed +13
-0
lines changed Original file line number Diff line number Diff line change @@ -15,6 +15,7 @@ Read the paper [here](https://arxiv.org/abs/1902.06714).
15
15
- [ Training the network] ( https://github.com/modern-fortran/neural-fortran#training-the-network )
16
16
- [ Saving and loading from file] ( https://github.com/modern-fortran/neural-fortran#saving-and-loading-from-file )
17
17
- [ MNIST training example] ( https://github.com/modern-fortran/neural-fortran#mnist-training-example )
18
+ * [ API documentation] ( https://github.com/modern-fortran/neural-fortran#api-documentation )
18
19
* [ Contributing] ( https://github.com/modern-fortran/neural-fortran#contributing )
19
20
* [ Contributors] ( https://github.com/modern-fortran/neural-fortran#contributors )
20
21
* [ Related projects] ( https://github.com/modern-fortran/neural-fortran#related-projects )
@@ -369,6 +370,18 @@ for example on 16 cores using [OpenCoarrays](https://github.com/sourceryinstitut
369
370
$ cafrun -n 16 ./example_mnist
370
371
```
371
372
373
+ ## API documentation
374
+
375
+ API documentation can be generated with [ FORD] ( https://github.com/Fortran-FOSS-Programmers/ford/ ) .
376
+ Assuming you have FORD installed on your system, run
377
+
378
+ ```
379
+ ford ford.md
380
+ ```
381
+
382
+ from the neural-fortran top-level directory to generate the API documentation in doc/html.
383
+ Point your browser to doc/html/index.html to read it.
384
+
372
385
## Contributing
373
386
374
387
neural-fortran is currently a proof-of-concept with potential for
You can’t perform that action at this time.
0 commit comments