data_mining_algorithms/README.md

Collection Of Data Mining Algorithm

What is this?

This is a collection of some algorithms and modules we use for data analyses

List of Algorithms

Name of Algorithm	Name of File	Author
k-Means	kmeansMkI.py	Tillmann and Conrad
k-Means (2D)	kmeansMkI_2d.py	Tillmann and Conrad
[ Your Algorithm ]	[ Your File Name]	[ Your Name ]

List of Modules

Name of Module	Author	Discription	Path
randomI.py	Tillmann and Conrad	Random data generator	src\data_generators\randomi.py
importer.py	Tillmann and Conrad	Importer for the algorithm	src\modules\importer.py

How to contribute

1. Write your algorithm (or part of it)
2. Choose a neat name for it (NAME in the following)
3. Fork this repository (or with rights: add a branch alg_NAME)
4. Create subfolder src/algorithms/NAME
5. Add your algorithm to the menu-script in the algorithm-folder
6. Add your algorithm to the list above in the following format NAME | Author
7. Create a readme.md-file in your main folder
8. Create a pull request to merge the data (if your algorithm works)

Pay attention: NEVER commit test data, passwords or personal information!

Have fun... :)

~