urban/data_mining_algorithms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Updated readme

Browse Source
This commit is contained in:
Conrad
2018-05-22 18:49:40 +02:00
parent 3787a59658
commit 880fa9f2eb
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -4,7 +4,7 @@
## What is this? ## What is this?
This is collection and collaboration of several scripts from people for data analysis algorithms. This is the collection of our algorithm and its modules for data analyses
## List of Algorithms ## List of Algorithms
@@ -13,6 +13,13 @@ This is collection and collaboration of several scripts from people for data ana
| [ PENDING ] | [ PENDING ] | | [ PENDING ] | [ PENDING ] |
| [ PENDING ] | [ PENDING ] | | [ PENDING ] | [ PENDING ] |
## 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 ## How to contribute
1. Write your algorithm (or part of it) 1. Write your algorithm (or part of it)
@@ -22,10 +29,10 @@ This is collection and collaboration of several scripts from people for data ana
5. Add your algorithm to the `menu`-script in the `algorithm`-folder 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` 6. Add your algorithm to the list above in the following format `NAME | Author`
7. Create a `HowToUse`-file in your main folder 7. Create a `HowToUse`-file in your main folder
**If your algorithm works:** **Only if your algorithm works:**
8. Create a pull request to merge the data 8. Create a pull request to merge the data
**Always pay attention: NEVER commit test data, passwords or personal information!** **Pay attention: NEVER commit test data, passwords or personal information!**
Have fun... :) Have fun... :)