From 314a82de2f99bcc4db0085dd8a82156cf4984743 Mon Sep 17 00:00:00 2001
From: "Olabarrieta Palacios, Ignacio" <ignacio.olabarrieta@tecnalia.com>
Date: Tue, 13 Dec 2022 09:10:49 +0100
Subject: [PATCH] adding/correcting documentation
---
.../bike-analysis.component.html | 20 ++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git a/src/app/pages/tecnalia-module/bike-analysis/bike-analysis.component.html b/src/app/pages/tecnalia-module/bike-analysis/bike-analysis.component.html
index 3685d9d9..8b038f49 100644
--- a/src/app/pages/tecnalia-module/bike-analysis/bike-analysis.component.html
+++ b/src/app/pages/tecnalia-module/bike-analysis/bike-analysis.component.html
@@ -228,10 +228,10 @@
This last button is important because inmediately after you submit the creation of a new model this one does NOT
show up in the table, the user should press the reload button to be able to see it.</li>
<li><b>Calendar:</b> The calendar is used to choose the day to be predicted, or the starting day of the period to be predicted.
- This is used once the models have been trainned. By default the selected day corresponds to the current day. Notice that is a prediction
- that involves weather is required only few days (4 days) in the future are susceptible to be predicted.</li>
+ This is used once the models have been trainned. By default the selected day corresponds to the current day. Notice that if a prediction
+ that involves weather is required only a few days (4 days) in the future are susceptible to be predicted.</li>
<li><b>Matrix Output:</b> Shows the predicted matrix at a future instance of time, actual hour can be chosen by a slider that can be found
- inmediately above this control.</li>
+ inmediately above this matrix.</li>
</ul>
On the map of the right hand side 3 buttons can be found:
<ul>
@@ -240,14 +240,15 @@
bike stations.</li>
<li><b>Load Areas:</b>This allows the user to specify the zonning for the OD Matrix computation by providing a geojson. Notice that the geojson
Features should have an integer "zone_id" property that is used for identify each of the zones. These "zone_id" properties should
- start in 1 and should be in consective order (i.e. no gaps are allowed). Right now this only allows to visualize, no areas can be uploaded dinamically</li>
+ start in 1 and should be in consective order (i.e. no gaps are allowed). Right now this buttom only allows the visualization of the areas,
+ it does not allow to upload new areas.</li>
</ul>
<h5>Create/Train Model</h5>
The trainning of a model can be initiated by pressing the <b>New Model</b>
button located inside the model table. This opens up a new window with two menus one for the areas available in the platform another one for specifiying the number
of features to be consider for the model:
<ul>
- <li><b>Areas:</b> The identification of the zonning to be used for the computation. The zonning should be created in advance, by defult the "districts" are generated. </li>
+ <li><b>Areas:</b> The identification of the zonning to be used for the computation. Right now the only available zonning are the "districts". </li>
<li><b>Num Features:</b> number of features considered to create the model:
<ul>
<li><b>1</b>: Considers only the time of the day, Hour of the Day (HoD). We call it the *slot* of the day, this corresponds to the time interval
@@ -255,11 +256,11 @@
<li><b>2</b>: In addition to the previous considers the day of the week (DoW).</li>
<li><b>3</b>: In addition to the previous considers if the given day is a School day and/or a Holiday or not (SaH).</li>
<li><b>4</b>: In addition to the previous considers the metereological variables (MET).</li>
- <li><b>5</b>: In addition to the previous considers events).</li>
+ <li><b>5</b>: In addition to the previous considers events.</li>
</ul></li>
</ul>
Once this information is properly set, the creation of the predicting model is started by pressing the <b>Submit</b> button. The information related
- to the models that have been created is shown in the <b>Models Table</b> as it can be seen in the following image:
+ to the models that have been created is shown in the <b>Models Table</b>.
The information that is shown for each model is:
<ul>
@@ -281,6 +282,11 @@
map showing the actual prediction of the confidence
interval associated with the prediction. The prediction is performed for the day selected in the calendar
or starting that day if the period is longer.
+
+ The result is shown in matrix form on the left bottom part of the module. The matrix has as many rows and columns
+ as areas in your zonning geojson, for districts zonning it is 8. Moving the slider on top of the matrix the time
+ of the prediction can be changed, hour by hour, and by clicking on one of the cells of the matrix the prediction
+ for the whole time period will be shown on the chart on the bottom right hand side.
</div>
</div>
</div>
--
GitLab