WIP(docs): add a framework for documentation

This commit is contained in:
sugarme 2020-07-10 12:25:40 +10:00
parent 8c842d6666
commit a49b35576f
5 changed files with 56 additions and 4 deletions

View File

@ -1,7 +1,49 @@
# DOCUMENTATIONS
# TABLE OF CONTENTS
## TABLE OF CONTENTS
## How to
### Tensor
- [Quick start guide](how-quickstart.md)
- [Installation](how-installation.md)
- [Cloud training](how-cloud.md)
- [Tensor indexing](tensor-operations.md)
## General
- [Data Types](gen-dtype.md)
- [Device](gen-device.md)
## Tensor
- [Tensor initiation](tensor-init.md)
- [Tensor indexing](tensor-indexing.md)
## Neural Network
- [Initiation](nn-init.md)
- [Optimizer](nn-optimizer.md)
- [Variable store](nn-varstore.md)
- [Layer - Sequential](nn-sequential.md)
- [Linear](nn-linear.md)
- [Convolutional Neural Network](nn-cnn.md)
- [Recurrent Neural Network](nn-rnn.md)
## Vision
- [Dataset](vision-dataset.md)
- [MNIST dataset](vision-mnist.md)
- [CIFAR dataset](vision-cifar.md)
- [Imagenet dataset](vision-imagenet.md)
- [Alexnet](vision-alexnet.md)
- [Densenet](vision-densenet.md)
- [Efficientnet](vision-efficientnet.md)
- [Inception](vision-inception.md)
- [Squeezenet](vision-squeezenet.md)
- [Mobilenet](vision-mobilenet.md)
- [VGG](vision-vgg.md)
## FAQs
- [Debug](faq-debug.md)
- [Memory blow-up](faq-memory-issues.md)
- [Report issues](faq-issues.md)
- [Contribution](faq-contribution.md)

3
docs/how-installation.md Normal file
View File

@ -0,0 +1,3 @@
# How to install
To be updated...

3
docs/how-quickstart.md Normal file
View File

@ -0,0 +1,3 @@
# Quick start guide
To be updated ...

4
docs/tensor-init.md Normal file
View File

@ -0,0 +1,4 @@
# Tensor initiation
To be updated...