From cd4e2aa77b5dd66d4898adf7494e47a0466a9595 Mon Sep 17 00:00:00 2001 From: VLE2FE Date: Tue, 1 Sep 2020 15:15:21 +0200 Subject: [PATCH] added model documentation --- src/app/app-routing.module.ts | 2 + src/app/app.component.html | 1 + .../documentation-models.component.html | 57 ++++++++++++++++++- 3 files changed, 59 insertions(+), 1 deletion(-) diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts index 5bcbf68..3c3ebdd 100644 --- a/src/app/app-routing.module.ts +++ b/src/app/app-routing.module.ts @@ -15,6 +15,7 @@ import {ModelTemplatesComponent} from './model-templates/model-templates.compone import {DocumentationArchitectureComponent} from './documentation/documentation-architecture/documentation-architecture.component'; import {MaterialsComponent} from './materials/materials.component'; import {MaterialComponent} from './material/material.component'; +import {DocumentationModelsComponent} from './documentation/documentation-models/documentation-models.component'; const routes: Routes = [ @@ -34,6 +35,7 @@ const routes: Routes = [ {path: 'documentation', component: DocumentationComponent}, {path: 'documentation/architecture', component: DocumentationArchitectureComponent}, {path: 'documentation/database', component: DocumentationDatabaseComponent}, + {path: 'documentation/models', component: DocumentationModelsComponent}, // if not authenticated { path: '**', redirectTo: '' } diff --git a/src/app/app.component.html b/src/app/app.component.html index 75d8741..3310240 100644 --- a/src/app/app.component.html +++ b/src/app/app.component.html @@ -18,6 +18,7 @@ General Architecture Database + Models diff --git a/src/app/documentation/documentation-models/documentation-models.component.html b/src/app/documentation/documentation-models/documentation-models.component.html index 3af7244..45f211d 100644 --- a/src/app/documentation/documentation-models/documentation-models.component.html +++ b/src/app/documentation/documentation-models/documentation-models.component.html @@ -1 +1,56 @@ -

documentation-models works!

+

Model file upload

+ +

+ Model files have to be saved as a .pkl file in 80_Modelle_BIC.
+ For upload the upload script has to be opened (can be in every environment). The name of the model file has to be + entered wih the .pkl ending in the first command and without .pkl in the second. +

+ +

Adding new model scripts

+ +

+ Open Spyder in the base environment and open the model.py within. +

+ + + +

Testing locally

+ +

+ To test the model Python script locally, you need to execute it in the base environment, in which all necessary + packages have to be installed. Note that Spyder also has to be opened in the base environment. +

+ + + +

Model script upload

+ +In the Windows Powershell: + + + +

+ After upload the new model details have to be entered in the UI. +

+ +