Skip to content

Commit 696e3c5

Browse files
param087param087
authored
Merge pull request #45 from param087/restructure
Restructured the library
2 parents 94ab2df + b92c8f3 commit 696e3c5

40 files changed

+109
-62
lines changed

‎CONTRIBUTING.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributors Guideline to swiftML
2+
3+
## Contributing code
4+
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) for more information on using pull requests.
5+
6+
## Beginner Issues
7+
If you are new to the project and want to get into the code, we recommend picking an issue with the label "good first issue". These issues should only require general programming knowledge and little to none insights into the project.
8+
9+
## Issue Allocation
10+
Each issue someone is currently working on should have an assignee. If you want to contribute to an issue someone else is already working on please make sure to get in contact with that person via slack or github and organize yourself.
11+
12+
If you want to work on an open issue, please post a comment telling that you will work on that issue, we will assign you as the assignee then.
13+
14+
**Caution**: We try our best to keep the assignee up-to-date but as we are all humans with our own schedule delays are possible, so make sure to check the comments once before you start working on an issue even when no one is assigned to it.
15+
16+
## Contribution guidelines and standards
17+
18+
Before sending your pull request for [review](https://github.com/param087/swiftML/pulls), make sure your changes are consistent with the guidelines.
19+
20+
### Testing
21+
* Include unit tests when you contribute new features, as they help to
22+
* Prove that your code works correctly.
23+
* Guard against future breaking changes to lower the maintenance cost.
24+
* Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.
25+
26+
### Swift coding style
27+
Changes should conform to:
28+
29+
[Google Swift Style Guide](https://google.github.io/swift/)
30+
[Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/)
31+
32+
With the exception that 4-space indendation be used.

‎Notebooks/AdaBoostClassifierTutorial.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
"source": [
8181
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
8282
" <td>\n",
83-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1NZELM8wGMEupkEkWG-xhiNiUKSEleCy4\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
83+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/AdaBoostClassifierTutorial.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
8484
" </td>\n",
8585
" <td>\n",
8686
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/AdaBoostClassifierTutorial.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -140,7 +140,7 @@
140140
}
141141
],
142142
"source": [
143-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
143+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
144144
]
145145
},
146146
{
@@ -500,4 +500,4 @@
500500
},
501501
"nbformat": 4,
502502
"nbformat_minor": 1
503-
}
503+
}

‎Notebooks/Bernoulli Naive Bayes.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
"source": [
8787
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
8888
" <td>\n",
89-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1Pkj7ZwAHHgQnFy93ZlmiYhnUcYb9xJLw\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
89+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/Bernoulli%20Naive%20Bayes.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
9090
" </td>\n",
9191
" <td>\n",
9292
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/Bernoulli%20Naive%20Bayes.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -138,7 +138,7 @@
138138
}
139139
],
140140
"source": [
141-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
141+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
142142
]
143143
},
144144
{
@@ -240,4 +240,4 @@
240240
},
241241
"nbformat": 4,
242242
"nbformat_minor": 2
243-
}
243+
}

‎Notebooks/DTreeTutorial.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
"source": [
8282
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
8383
" <td>\n",
84-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1S0UP89ZoIJq7Kgkzlp2lie_SWmseR5qL\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
84+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/DTreeTutorial.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
8585
" </td>\n",
8686
" <td>\n",
8787
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/DTreeTutorial.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -141,7 +141,7 @@
141141
}
142142
],
143143
"source": [
144-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
144+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
145145
]
146146
},
147147
{
@@ -622,4 +622,4 @@
622622
},
623623
"nbformat": 4,
624624
"nbformat_minor": 1
625-
}
625+
}

‎Notebooks/Gaussian Naive Bayes.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
"source": [
7979
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
8080
" <td>\n",
81-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1d2GSO02MqRfxBv4Ep0mXYcNPdLWWpS1f\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
81+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/Gaussian%20Naive%20Bayes.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
8282
" </td>\n",
8383
" <td>\n",
8484
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/Gaussian%20Naive%20Bayes.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -131,7 +131,7 @@
131131
}
132132
],
133133
"source": [
134-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
134+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
135135
]
136136
},
137137
{
@@ -251,4 +251,4 @@
251251
},
252252
"nbformat": 4,
253253
"nbformat_minor": 2
254-
}
254+
}

‎Notebooks/Gradient Descent Linear Regression.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
"source": [
7777
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
7878
" <td>\n",
79-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1IZdek-xMr7A5ccE7VUvl6Pi5ydCggo5c\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
79+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/Gradient%20Descent%20Linear%20Regression.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
8080
" </td>\n",
8181
" <td>\n",
8282
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/Gradient%20Descent%20Linear%20Regression.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -129,7 +129,7 @@
129129
}
130130
],
131131
"source": [
132-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
132+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
133133
]
134134
},
135135
{
@@ -367,4 +367,4 @@
367367
},
368368
"nbformat": 4,
369369
"nbformat_minor": 2
370-
}
370+
}

‎Notebooks/GradientRegressorTutorial.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
"source": [
8383
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
8484
" <td>\n",
85-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1EnGe36DZF9QUkj3FEGKSKkdGH-UnA_MW\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
85+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/GradientRegressorTutorial.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
8686
" </td>\n",
8787
" <td>\n",
8888
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/GradientRegressorTutorial.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -142,7 +142,7 @@
142142
}
143143
],
144144
"source": [
145-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
145+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
146146
]
147147
},
148148
{
@@ -502,4 +502,4 @@
502502
},
503503
"nbformat": 4,
504504
"nbformat_minor": 1
505-
}
505+
}

‎Notebooks/KMeans Clustering.ipynb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164
}
165165
],
166166
"source": [
167-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
167+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
168168
]
169169
},
170170
{
@@ -492,4 +492,4 @@
492492
},
493493
"nbformat": 4,
494494
"nbformat_minor": 2
495-
}
495+
}

‎Notebooks/KNeighbor Classifier.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
"source": [
7575
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
7676
" <td>\n",
77-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1i9I4e_lXIDJLGOQ_Ki3nx6hI1RQ47Qep\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
77+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/KNeighbor%20Classifier.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
7878
" </td>\n",
7979
" <td>\n",
8080
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/KNeighbor%20Classifier.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -127,7 +127,7 @@
127127
}
128128
],
129129
"source": [
130-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
130+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
131131
]
132132
},
133133
{
@@ -268,4 +268,4 @@
268268
},
269269
"nbformat": 4,
270270
"nbformat_minor": 2
271-
}
271+
}

‎Notebooks/KNeighbor Regressor.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
"source": [
7575
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
7676
" <td>\n",
77-
" <a target=\"_blank\" href=\"https://colab.research.google.com/drive/1RKhzTFxsTer3kiKSIgR2m78nTl2wk5N6\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
77+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/param087/swiftML/blob/master/Notebooks/KNeighbor%20Regressor.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
7878
" </td>\n",
7979
" <td>\n",
8080
" <a target=\"_blank\" href=\"https://github.com/param087/swiftML/blob/master/Notebooks/KNeighbor%20Regressor.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
@@ -127,7 +127,7 @@
127127
}
128128
],
129129
"source": [
130-
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.2\")' swiftML"
130+
"%install '.package(url: \"https://github.com/param087/swiftML\", from: \"0.0.4\")' swiftML"
131131
]
132132
},
133133
{
@@ -417,4 +417,4 @@
417417
},
418418
"nbformat": 4,
419419
"nbformat_minor": 2
420-
}
420+
}

0 commit comments

Comments
 (0)