36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
[](https://www.gnu.org/licenses/agpl-3.0)
|
|
# 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](https://github.com/tchemn) and [Conrad](https://github.com/creyd) |
|
|
| k-Means (2D) | kmeansMkI_2d.py | [Tillmann](https://github.com/tchemn) and [Conrad](https://github.com/creyd) |
|
|
| [ Your Algorithm ] | [ Your File Name] | [ Your Name ] |
|
|
|
|
## List of Modules
|
|
|
|
| Name of Module | Author | Discription | Path |
|
|
| ------------- | ------------- | ------------- | ------------- |
|
|
| randomI.py | [Tillmann](https://github.com/tchemn) and [Conrad](https://github.com/creyd) | Random data generator | src\data_generators\randomi.py |
|
|
| importer.py | [Tillmann](https://github.com/tchemn) and [Conrad](https://github.com/creyd) | Importer for the algorithm | src\modules\importer.py |
|
|
|
|
## How to contribute
|
|
|
|
1. Write your algorithm (and test it!)
|
|
2. Choose a neat name for it (NAME in the following)
|
|
3. Fork this repository
|
|
4. Create subfolder `src/algorithms/NAME` with your algorithm and a `readme.md`-file
|
|
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 pull request to merge the data (if your algorithm works)
|
|
|
|
**Pay attention: Please don't commit test data. NEVER commit passwords or personal information!**
|
|
|
|
~
|