Skip to content

Commit 1315dc7

Browse files
committed
README.md installation instructions added
1 parent d6dce8b commit 1315dc7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Modular Active Learning framework for Python3
1111
- [Replacing parts quickly](#replacing-parts)
1212
- [Replacing parts with your own solutions](#replacing-parts-with-your-own-solutions)
1313
- [Working examples](#working-examples)
14+
- [Installation](#installation)
15+
- [Documentation](#documentation)
1416
- [About the developer](#about-the-developer)
1517

1618
## Introduction<a name="introduction"></a>
@@ -89,5 +91,21 @@ To see modAL in *real* action, visit the examples section!
8991
- [Bootstrapping and bagging](https://cosmic-cortex.github.io/modAL/Bootstrapping-and-bagging)
9092
- [Keras integration](https://cosmic-cortex.github.io/modAL/Keras-integration)
9193

94+
## Installation<a name="installation"></a>
95+
modAL requires
96+
- Python >= 3.5
97+
- NumPy >= 1.13
98+
- SciPy >= 0.18
99+
- scikit-learn >= 0.18
100+
101+
You can install modAL directly with pip:
102+
```pip install modAL```
103+
Alternatively, you can install modAL directly from source:
104+
```pip install git+https://github.com/cosmic-cortex/modAL.git```
105+
106+
## Documentation<a name="documentation"></a>
107+
108+
You can find the documentation of modAL at [https://cosmic-cortex.github.io/modAL](https://cosmic-cortex.github.io/modAL), where several tutorials and working examples are available, along with a complete API reference. For running the examples, Matplotlib >= 2.0 is recommended.
109+
92110
## About the developer<a name="about-the-developer">
93111
modAL is developed by me, [Tivadar Danka](https://www.tivadardanka.com) (aka [cosmic-cortex](https://github.com/cosmic-cortex) in GitHub). I have a PhD in pure mathematics, but I fell in love with biology and machine learning right after I finished my PhD. I have changed fields and now I work in the [Bioimage Analysis and Machine Learning Group of Peter Horvath](http://group.szbk.u-szeged.hu/sysbiol/horvath-peter-lab-index.html), where I am working to develop active learning strategies for intelligent sample analysis in biology. During my work I realized that in Python, creating and prototyping active learning workflows can be made really easy and fast with scikit-learn, so I ended up developing a general framework for this. The result is modAL :) If you have any questions, requests or suggestions, you can contact me at <a href="mailto:[email protected]">[email protected]</a>! I hope you'll find modAL useful!

0 commit comments

Comments
 (0)