From da837bcfcb037496b50046d3dabd5ba7372fb026 Mon Sep 17 00:00:00 2001
From: leufen1 <l.leufen@fz-juelich.de>
Date: Thu, 8 Oct 2020 15:37:52 +0200
Subject: [PATCH] prepared release
---
CHANGELOG.md | 8 ++++++++
README.md | 2 +-
docs/_source/get-started.rst | 2 +-
mlair/__init__.py | 8 ++++----
4 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a276b5ea..68e01ad5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,14 @@
# Changelog
All notable changes to this project will be documented in this file.
+## v1.0.0 - 2020-10-08 - official release of new version 1.0.0
+
+### general:
+- This is the first official release of MLAir ready for use
+- updated license, installation instruction
+
+### technical:
+- restructured order of packages in requirements
## v0.12.2 - 2020-10-01 - HDFML support
diff --git a/README.md b/README.md
index 40954c78..5babd3f2 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ HPC systems, see [here](#special-instructions-for-installation-on-jülich-hpc-sy
* Installation of **MLAir**:
* 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 ([current version](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-0.12.2-py3-none-any.whl))
+ * or download the distribution file ([current version](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-1.0.0-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`.
* (tf) Currently, TensorFlow-1.13 is mentioned in the requirements. We already tested the TensorFlow-1.15 version and couldn't
diff --git a/docs/_source/get-started.rst b/docs/_source/get-started.rst
index ee4a53e9..5c2f81f7 100644
--- a/docs/_source/get-started.rst
+++ b/docs/_source/get-started.rst
@@ -31,7 +31,7 @@ Installation of MLAir
* Install all requirements from `requirements.txt <https://gitlab.version.fz-juelich.de/toar/machinelearningtools/-/blob/master/requirements.txt>`_
preferably in a virtual environment
* Either clone MLAir from the `gitlab repository <https://gitlab.version.fz-juelich.de/toar/machinelearningtools.git>`_
-* or download the distribution file (`current version <https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-0.12.2-py3-none-any.whl>`_)
+* or download the distribution file (`current version <https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-1.0.0-py3-none-any.whl>`_)
and install it via :py:`pip install <dist_file>.whl`. In this case, you can simply
import MLAir in any python script inside your virtual environment using :py:`import mlair`.
* (tf) Currently, TensorFlow-1.13 is mentioned in the requirements. We already tested the TensorFlow-1.15 version and couldn't
diff --git a/mlair/__init__.py b/mlair/__init__.py
index 0332c7b9..7097b1f3 100644
--- a/mlair/__init__.py
+++ b/mlair/__init__.py
@@ -1,7 +1,7 @@
__version_info__ = {
- 'major': 0,
- 'minor': 12,
- 'micro': 2,
+ 'major': 1,
+ 'minor': 0,
+ 'micro': 0,
}
from mlair.run_modules import RunEnvironment, ExperimentSetup, PreProcessing, ModelSetup, Training, PostProcessing
@@ -13,7 +13,7 @@ from mlair.model_modules import AbstractModelClass
def get_version():
assert set(__version_info__.keys()) >= {"major", "minor"}
vers = [f"{__version_info__['major']}.{__version_info__['minor']}"]
- if __version_info__["micro"]:
+ if "micro" in __version_info__:
vers.append(f".{__version_info__['micro']}")
return "".join(vers)
--
GitLab