diff --git a/CHANGELOG.md b/CHANGELOG.md index e0c57c86048251f3125b58e17aa9b999cd4581f3..7d17fa89513192bf7d8ce0fa39e6e1449dc9b4f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,19 @@ All notable changes to this project will be documented in this file. +## v0.12.1 - 2020-09-28 - examples in notebook + +### general: +- introduced a notebook documentation for easy starting, #174 +- updated special installation instructions for the Juelich HPC systems, #172 + +### new features: +- names of input and output shape are renamed consistently to: input_shape, and output_shape, #175 + +### technical: +- it is possible to assign a custom name to a run module (e.g. used in logging), #173 + + ## v0.12.0 - 2020-09-21 - Documentation and Bugfixes ### general: diff --git a/README.md b/README.md index 1198c6ae377519ae595e2609b053eb91a7bba01e..dfbcc518341e4f10f642f385b1b60633f56b5ee0 100644 --- a/README.md +++ b/README.md @@ -17,17 +17,18 @@ install the geo packages. For special instructions to install MLAir on the Jueli * (geo) Install **proj** on your machine using the console. E.g. for opensuse / leap `zypper install proj` * (geo) A c++ compiler is required for the installation of the program **cartopy** -* Install all requirements from [`requirements.txt`](https://gitlab.version.fz-juelich.de/toar/machinelearningtools/-/blob/master/requirements.txt) +* Install all requirements from [`requirements.txt`](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/requirements.txt) preferably in a virtual environment * (tf) Currently, TensorFlow-1.13 is mentioned in the requirements. We already tested the TensorFlow-1.15 version and couldn't find any compatibility errors. Please note, that tf-1.13 and 1.15 have two distinct branches each, the default branch for CPU support, and the "-gpu" branch for GPU support. If the GPU version is installed, MLAir will make use of the GPU device. * Installation of **MLAir**: - * Either clone MLAir from the [gitlab repository](https://gitlab.version.fz-juelich.de/toar/machinelearningtools.git) + * Either clone MLAir from the [gitlab repository](https://gitlab.version.fz-juelich.de/toar/mlair.git) and use it without installation (beside the requirements) - * or download the distribution file (?? .whl) and install it via `pip install <??>`. In this case, you can simply - import MLAir in any python script inside your virtual environment using `import mlair`. + * or download the distribution file ([current version](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-0.12.1-py3-none-any.whl)) + and install it via `pip install <dist_file>.whl`. In this case, you can simply import MLAir in any python script + inside your virtual environment using `import mlair`. # How to start with MLAir diff --git a/dist/mlair-0.12.1-py3-none-any.whl b/dist/mlair-0.12.1-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..940e25d1973e6d66328482d6e88a9457b5b88c71 Binary files /dev/null and b/dist/mlair-0.12.1-py3-none-any.whl differ diff --git a/mlair/__init__.py b/mlair/__init__.py index 0cfc33bb6ca17496e68e5e6281fa37a53a66466b..c0f6183fc3c30cd91818915de12115fd9679f648 100644 --- a/mlair/__init__.py +++ b/mlair/__init__.py @@ -1,7 +1,7 @@ __version_info__ = { 'major': 0, 'minor': 12, - 'micro': 0, + 'micro': 1, } from mlair.run_modules import RunEnvironment, ExperimentSetup, PreProcessing, ModelSetup, Training, PostProcessing