Merge branch 'release/0.2.0'

Author: mlange-42

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "kohonen"
-version = "0.1.6"
+version = "0.2.0"
 authors = ["m-lange <martin_lange_@gmx.net>"]
 edition = "2018"
 

Cargo.toml

@@ -1,5 +1,33 @@
 # kohonen
 A Rust Self-organizing Maps (SOM) / Kohonen networks library and command line tool.
 
-This project is in a very experimental state and does not yet provide much useful
-functionality except a plain multilayered Kohonen map (aka Super-SOM) implementation.
+_Warning:_ This project is in a very experimental state.
+
+## Self-organizing maps
+
+* [SOM on Wikipedia](https://en.wikipedia.org/wiki/Self-organizing_map)
+* For Super-SOMs, see [this paper](https://www.jstatsoft.org/article/view/v021i05) about a respective R package.
+
+## Command line tool
+
+### Installation
+
+* Download the [latest binaries](https://github.com/mlange-42/kohonen/releases/latest).
+* Unzip somewhere with write privileges (only required for running examples in place).
+
+### Usage
+
+* Try the examples in sub-directory `cmd_examples`.
+* To view the full list of options, run `kohonen --help`
+
+## Library / crate
+
+To use this crate as a library, add the following to your `Cargo.toml` dependencies section:
+```
+kohonen = { git = "https://github.com/mlange-42/kohonen.git" }
+```
+See the included examples for usage details.
+
+## Development version
+
+For the latest development version, see branch [`dev`](https://github.com/mlange-42/kohonen/tree/dev).

README.md

@@ -1,16 +1,18 @@
 ..\target\release\kohonen.exe ^
 --file ..\example_data\countries.csv ^
 --size 16 12 ^
---episodes 5000 ^
---layers "child_mort_2010 birth_p_1000 GNI LifeExpectancy PopGrowth PopUrbanized PopGrowthUrb AdultLiteracy PrimSchool Income_low_40 Income_high_20" "continent" ^
+--epochs 2500 ^
+--layers "child_mort_2010 birth_p_1000 log_GNI LifeExpectancy PopGrowth PopUrbanized PopGrowthUrb AdultLiteracy PrimSchool Income_low_40 Income_high_20" "continent" ^
 --preserve Country code ^
---categ 0 1 ^
+--labels Country ^
+--label-length 10 ^
+--categ false true ^
 --norm gauss none ^
---weights 1 1 ^
+--weights 1 0.5 ^
 --alpha 0.2 0.01 lin ^
---radius 10 0.8 lin ^
+--radius 6 0.8 lin ^
 --decay 0.2 0.001 exp ^
 --neigh gauss ^
 --no-data - ^
 --fps 1 ^
---output ..\example_data\countries
+--output ..\example_data\_countries

cmd_examples/countries.bat

@@ -1,13 +1,14 @@
 ..\target\release\kohonen.exe ^
 --file ..\example_data\iris.csv ^
---size 20 16 ^
---episodes 2500 ^
+--size 16 12 ^
+--epochs 250 ^
 --layers "sepal_length sepal_width petal_length petal_width" "species" ^
---categ 0 1 ^
+--labels species ^
+--categ false true ^
 --norm gauss none ^
---weights 1 1 ^
+--weights 1 0.5 ^
 --alpha 0.2 0.01 lin ^
 --radius 8 0.7 lin ^
 --decay 0.2 0.001 exp ^
 --neigh gauss ^
---output ..\example_data\iris
+--output ..\example_data\_iris

cmd_examples/iris.bat

@@ -0,0 +1,17 @@
+..\target\release\kohonen.exe ^
+--file ..\example_data\us-congress-votes.csv ^
+--size 16 12 ^
+--epochs 1000 ^
+--layers "handicapped-infants water-project-cost-sharing adoption-of-the-budget-resolution physician-fee-freeze el-salvador-aid religious-groups-in-schools anti-satellite-test-ban aid-to-nicaraguan-contras mx-missile immigration synfuels-corporation-cutback education-spending superfund-right-to-sue crime duty-free-exports export-administration-act-south-africa" "party" ^
+--labels label ^
+--label-length 10 ^
+--categ false true ^
+--norm none none ^
+--weights 1 0.5 ^
+--alpha 0.2 0.01 lin ^
+--radius 6 0.8 lin ^
+--decay 0.2 0.001 exp ^
+--neigh gauss ^
+--no-data - ^
+--fps 1 ^
+--output ..\example_data\_us-congress-votes

cmd_examples/us-congress-votes.bat

@@ -0,0 +1,16 @@
+..\target\release\kohonen.exe ^
+--file ..\example_data\winequality-red.csv ^
+--size 16 12 ^
+--epochs 1000 ^
+--layers "fixed-acidity volatile-acidity citric-acid residual-sugar chlorides free-sulfur-dioxide total-sulfur-dioxide density pH sulphates alcohol" "quality" ^
+--labels quality ^
+--categ false false ^
+--norm gauss unit ^
+--weights 1 0.5 ^
+--alpha 0.2 0.01 lin ^
+--radius 6 0.8 lin ^
+--decay 0.2 0.001 exp ^
+--neigh gauss ^
+--no-data - ^
+--fps 1 ^
+--output ..\example_data\_winequality-red

cmd_examples/winequality-red.bat

@@ -0,0 +1,16 @@
+..\target\release\kohonen.exe ^
+--file ..\example_data\winequality-white.csv ^
+--size 16 12 ^
+--epochs 1000 ^
+--layers "fixed-acidity volatile-acidity citric-acid residual-sugar chlorides free-sulfur-dioxide total-sulfur-dioxide density pH sulphates alcohol" "quality" ^
+--labels quality ^
+--categ false false ^
+--norm gauss unit ^
+--weights 1 0.5 ^
+--alpha 0.2 0.01 lin ^
+--radius 6 0.8 lin ^
+--decay 0.2 0.001 exp ^
+--neigh gauss ^
+--no-data - ^
+--fps 1 ^
+--output ..\example_data\_winequality-white

cmd_examples/winequality-white.bat

@@ -0,0 +1,3 @@
+*-out.csv
+*-units.csv
+*-som.json