Skip to content

Commit 13295e0

Browse files
merguastorfi
mergu
authored and
astorfi
committed
Update some of the info in the readme and site index page (#26)
* Update some of the info in the readme and site index page * Fix links that were brought up in user testing * Fix link in clustering that
1 parent 227e3be commit 13295e0

File tree

8 files changed

+60
-62
lines changed

8 files changed

+60
-62
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
.DS_Store
2-
2+
.vs

‎.vs/VSWorkspaceState.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎.vs/machine-learning-for-everybody/v15/.suo

-11 KB
Binary file not shown.

‎.vs/slnx.sqlite

-72 KB
Binary file not shown.

‎README.rst

Lines changed: 48 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ Machine Learning
6262
------------------------------------------------------------
6363
Machine Learning Basics
6464
------------------------------------------------------------
65+
6566
.. figure:: _img/deeplearning.png
6667
.. _lrtutorial: docs/source/content/overview/linear-regression.rst
6768
.. _lrcode: code/overview/linear_regression
@@ -70,24 +71,24 @@ Machine Learning Basics
7071
.. _overcode: code/overview/overfitting
7172

7273
.. _regtutorial: docs/source/content/overview/regularization.rst
73-
.. _regpython: code/overview/regularization
74+
.. _regcode: code/overview/regularization
7475

7576
.. _crosstutorial: docs/source/content/overview/crossvalidation.rst
76-
.. _crosspython: code/overview/cross-validation
77+
.. _crosscode: code/overview/cross-validation
7778

7879

7980

8081

8182
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
8283
| Title | Code | Document |
8384
+====================================================================+===============================+================================+
84-
| Linear Regression | `Python <lrcode_>`_ | `Tutorial <lrtutorial_>`_ |
85+
| Linear Regression | `Python <lrcode_>`_ | `Tutorial <lrtutorial_>`_ |
8586
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
86-
| overfitting | `Python <overcode_>`_ | `Tutorial <overtutorial_>`_ |
87+
| Overfitting / Underfitting | `Python <overcode_>`_ | `Tutorial <overtutorial_>`_ |
8788
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
88-
| regularization | `Python <regpython_>`_ | `Tutorial <regtutorial_>`_ |
89+
| Regularization | `Python <regcode_>`_ | `Tutorial <regtutorial_>`_ |
8990
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
90-
| cross-validation | `Python <crosspython_>`_ | `Tutorial <crosstutorial_>`_ |
91+
| Cross-Validation | `Python <crosscode_>`_ | `Tutorial <crosstutorial_>`_ |
9192
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
9293

9394

@@ -109,7 +110,6 @@ Supervised learning
109110
.. _logisticrdoc: docs/source/content/supervised/logistic_regression.rst
110111
.. _logisticrcode: supervised/Logistic_Regression/logistic_ex1.py
111112

112-
113113
.. _linearsvmdoc: docs/source/content/supervised/linear_SVM.rst
114114
.. _linearsvmcode: code/supervised/Linear_SVM/linear_svm.py
115115

@@ -118,9 +118,9 @@ Supervised learning
118118
+--------------------------------------------------------------------+-------------------------------+------------------------------+
119119
| Title | Code | Document |
120120
+====================================================================+===============================+==============================+
121-
| Decision trees | `Python <dtcode_>`_ | `Tutorial <dtdoc_>`_ |
121+
| Decision Trees | `Python <dtcode_>`_ | `Tutorial <dtdoc_>`_ |
122122
+--------------------------------------------------------------------+-------------------------------+------------------------------+
123-
| K-Nearest Neighbor | `Python <knncode_>`_ | `Tutorial <knndoc_>`_ |
123+
| K-Nearest Neighbors | `Python <knncode_>`_ | `Tutorial <knndoc_>`_ |
124124
+--------------------------------------------------------------------+-------------------------------+------------------------------+
125125
| Naive Bayes | `Python <nbcode_>`_ | `Tutorial <nbdoc_>`_ |
126126
+--------------------------------------------------------------------+-------------------------------+------------------------------+
@@ -141,44 +141,51 @@ Unsupervised learning
141141
.. _clusteringdoc: docs/source/content/unsupervised/clustering.rst
142142
.. _clusteringcode: code/unsupervised/Clustering
143143

144+
.. _pcadoc: docs/source/content/unsupervised/pca.rst
145+
.. _pcacode: code/unsupervised/PCA
146+
144147
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
145148
| Title | Code | Document |
146149
+====================================================================+===============================+================================+
147-
| clustering | `Python <clusteringcode_>`_ | `Tutorial <clusteringdoc_>`_ |
150+
| Clustering | `Python <clusteringcode_>`_ | `Tutorial <clusteringdoc_>`_ |
148151
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
149-
| Principal Components Analysis | | |
152+
| Principal Components Analysis | `Python <pcacode_>`_ | `Tutorial <pcadoc_>`_ |
150153
+--------------------------------------------------------------------+-------------------------------+--------------------------------+
151154

152-
.. ------------------------------------------------------------
153-
.. Deep Learning
154-
.. ------------------------------------------------------------
155-
..
156-
.. .. _conganpaper: https://arxiv.org/abs/1411.1784
157-
.. .. _congancode: https://github.com/zhangqianhui/Conditional-GAN
158-
..
159-
.. .. _photorealpaper: https://arxiv.org/pdf/1609.04802.pdf
160-
.. .. _photorealcode: https://github.com/tensorlayer/srgan
161-
..
162-
.. .. _im2impaper: https://arxiv.org/abs/1611.07004
163-
.. .. _im2imcode: https://github.com/phillipi/pix2pix
164-
..
165-
.. .. _vismanpaper: https://arxiv.org/abs/1609.03552
166-
.. .. _vismancode: https://github.com/junyanz/iGAN
167-
..
168-
..
169-
..
170-
..
171-
.. +--------------------------------------------------------------------+-------------------------------+---------------------------+
172-
.. | Title | Text | Software |
173-
.. +====================================================================+===============================+===========================+
174-
.. | Neural Networks Overview | | |
175-
.. +--------------------------------------------------------------------+-------------------------------+---------------------------+
176-
.. | Convolutional Neural Networks | | |
177-
.. +--------------------------------------------------------------------+-------------------------------+---------------------------+
178-
.. | Recurrent Neural Networks | | |
179-
.. +--------------------------------------------------------------------+-------------------------------+---------------------------+
180-
.. | Autoencoders | | |
181-
.. +--------------------------------------------------------------------+-------------------------------+---------------------------+
155+
156+
157+
158+
------------------------------------------------------------
159+
Deep Learning
160+
------------------------------------------------------------
161+
162+
.. _conganpaper: https://arxiv.org/abs/1411.1784
163+
.. _congancode: https://github.com/zhangqianhui/Conditional-GAN
164+
165+
.. _photorealpaper: https://arxiv.org/pdf/1609.04802.pdf
166+
.. _photorealcode: https://github.com/tensorlayer/srgan
167+
168+
.. _im2impaper: https://arxiv.org/abs/1611.07004
169+
.. _im2imcode: https://github.com/phillipi/pix2pix
170+
171+
.. _vismanpaper: https://arxiv.org/abs/1609.03552
172+
.. _vismancode: https://github.com/junyanz/iGAN
173+
174+
175+
.. _cnndoc: docs/source/content/deep_learning/cnn.rst
176+
177+
178+
+--------------------------------------------------------------------+-------------------------------+---------------------------+
179+
| Title | Code | Document |
180+
+====================================================================+===============================+===========================+
181+
| Neural Networks Overview | | |
182+
+--------------------------------------------------------------------+-------------------------------+---------------------------+
183+
| Convolutional Neural Networks | | `Tutorial <cnndoc_>`_ |
184+
+--------------------------------------------------------------------+-------------------------------+---------------------------+
185+
| Recurrent Neural Networks | | |
186+
+--------------------------------------------------------------------+-------------------------------+---------------------------+
187+
| Autoencoders | | |
188+
+--------------------------------------------------------------------+-------------------------------+---------------------------+
182189

183190

184191

‎docs/source/content/overview/crossvalidation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,9 @@ train-test data split is created with the `split()` method:
221221
Note that you can change the P value at the top of the script to see
222222
how different values operate.
223223

224-
.. _holdout.py: /https://github.com/machinelearningmindset/machine-learning-course/tree/mastercode/overview/cross-validation/holdout.py
225-
.. _k-fold.py: /https://github.com/machinelearningmindset/machine-learning-course/tree/mastercode/overview/cross-validation/k-fold.py
226-
.. _leave-p-out.py: /https://github.com/machinelearningmindset/machine-learning-course/tree/mastercode/overview/cross-validation/leave-p-out.py
224+
.. _holdout.py: https://github.com/machinelearningmindset/machine-learning-course/tree/mastercode/overview/cross-validation/holdout.py
225+
.. _k-fold.py: https://github.com/machinelearningmindset/machine-learning-course/tree/mastercode/overview/cross-validation/k-fold.py
226+
.. _leave-p-out.py: https://github.com/machinelearningmindset/machine-learning-course/tree/mastercode/overview/cross-validation/leave-p-out.py
227227

228228

229229
************

‎docs/source/content/unsupervised/clustering.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ K-Means is a good choice.
128128

129129
The relevant code is available in the clustering_kmeans.py_ file.
130130

131-
.. _clustering_kmeans.py: https://github.com/machinelearningmindset/machine-learning-course/code/unsupervised/Clustering/clustering_kmeans.py
131+
.. _clustering_kmeans.py: https://github.com/machinelearningmindset/machine-learning-course/blob/master/code/unsupervised/Clustering/clustering_kmeans.py
132132

133133
In the code, we create the simple data set to use for analysis. Setting up the
134134
clustering is very simple and requires one line of code:
@@ -187,7 +187,7 @@ the number of expected clusters.
187187

188188
The relevant code is available in the clustering_hierarchical.py_ file.
189189

190-
.. _clustering_hierarchical.py: https://github.com/machinelearningmindset/machine-learning-course/code/unsupervised/Clustering/clustering_hierarchical.py
190+
.. _clustering_hierarchical.py: https://github.com/machinelearningmindset/machine-learning-course/blob/master/code/unsupervised/Clustering/clustering_hierarchical.py
191191

192192
In the code, we create the simple data set to use for analysis. Setting up the
193193
clustering is very simple and requires one line of code:

‎docs/source/index.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,13 @@ Welcome to Deep Learning NLP documentation!
3636
:caption: Unsupervised Learning
3737

3838
content/unsupervised/clustering
39+
content/unsupervised/pca
3940

40-
.. :maxdepth: 3
41-
.. :caption: Supervised Learning
42-
..
43-
.. content/supervised/logistic_regression
44-
.. content/supervised/bayes
45-
.. content/supervised/decisiontrees
46-
.. content/supervised/knn
47-
.. content/supervised/linear_SVM
41+
.. toctree::
42+
:maxdepth: 3
43+
:caption: Deep Learning
44+
45+
content/deep_learning/cnn
4846

4947
.. toctree::
5048
:maxdepth: 3

0 commit comments

Comments
 (0)