From a36c71f2c6a7f0d86cede6c41ce9b0cef53e4309 Mon Sep 17 00:00:00 2001
From: lukas leufen <l.leufen@fz-juelich.de>
Date: Thu, 16 Jul 2020 11:52:55 +0200
Subject: [PATCH] updated conf
---
docs/_source/conf.py | 4 ++--
docs/_source/get-started.rst | 11 ++++++-----
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/docs/_source/conf.py b/docs/_source/conf.py
index ac1131a0..573918ee 100644
--- a/docs/_source/conf.py
+++ b/docs/_source/conf.py
@@ -17,7 +17,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
-project = 'machinelearningtools'
+project = 'MLAir'
copyright = '2020, Lukas H Leufen, Felix Kleinert'
author = 'Lukas H Leufen, Felix Kleinert'
@@ -118,7 +118,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'machinelearningtools.tex', 'MachineLearningTools Documentation',
+ (master_doc, 'mlair.tex', 'MLAir Documentation',
author, 'manual'),
]
diff --git a/docs/_source/get-started.rst b/docs/_source/get-started.rst
index e327ee9a..98a96d43 100644
--- a/docs/_source/get-started.rst
+++ b/docs/_source/get-started.rst
@@ -1,8 +1,8 @@
-Get started with MachineLearningTools
-=====================================
+Get started with MLAir
+======================
-Install MachineLearningTools
-----------------------------
+Install MLAir
+-------------
MLAir is based on several python frameworks. To work properly, you have to install all packages from the
`requirements.txt` file. Additionally to support the geographical plotting part it is required to install geo
@@ -138,6 +138,7 @@ MLAir provides a default workflow. If additional steps are to be performed, you
the workflow.
.. code-block:: python
+
import mlair
import logging
@@ -224,7 +225,7 @@ required to implement the set model and set compile options methods. The later h
x_in = keras.layers.Dense(self.window_lead_time)(x_in)
out = self.activation()(x_in)
self.model = keras.Model(inputs=x_input, outputs=[out])
-
+
def set_compile_options(self):
self.compile_options = {"optimizer": SGD(lr=self.lr),
"loss": mse,
--
GitLab