Jensen-holm commited on
Commit
dca0a99
·
1 Parent(s): 902aba3

algorithm specific documentation in readme

Browse files
Files changed (1) hide show
  1. README.md +12 -6
README.md CHANGED
@@ -38,11 +38,17 @@ print(model_data)
38
 
39
  ### Parameter Options
40
 
41
- \*\*Algorithm: <br>
42
 
43
- - `"neural-network"` <br>
44
- - `"kmeans-clustering"` <br>
45
- - `"kmedoid-clustering"` <br>
46
- - `"heirarchical-clustering"` <br>
47
 
48
- \*\*Algorithm Specific Parameters
 
 
 
 
 
 
 
38
 
39
  ### Parameter Options
40
 
41
+ - Algorithm: <br>
42
 
43
+ * `"neural-network"` <br>
44
+ * `"kmeans-clustering"` <br>
45
+ * `"kmedoid-clustering"` <br>
46
+ * `"heirarchical-clustering"` <br>
47
 
48
+ - Algorithm Specific Arguments
49
+
50
+ - neural-network
51
+ - epochs: any integer
52
+ - activation_func: tanh, sigmoid, or relu
53
+ - hidden_size: must be an even integer
54
+ - learning_rate: any floating point number