[DOCS] This patch adds documentation.
[thoth.git] / docs / models / models.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Anuket, The Linux Foundation, BIT Mesra, VTU and Others.
4
5
6 ==============================
7 AI/ML Models for NFV Usecases.
8 ==============================
9
10 This document describes all the models created by Anuket-Thoth project.
11
12 *********************************
13 1. Failure prediction (FP) models
14 *********************************
15
16 a. Summary of the VM Failure-Prediction models.
17 ===============================================
18 We have developed Neural Network models for predicting failures in
19 virtual machines (VMs) used in network function virtualization (NFV)
20 environments by analysing VNF data. The data used to build these models
21 are provided by Orange Labs, and the VMs are based on project Clearwater.
22
23 The links for the data are:
24
25 * Processed Data: https://drive.google.com/drive/folders/1crrVZMJwf00MP5qM7nmVEqFsatOAShla
26 * Raw: https://drive.google.com/file/d/1QVipyoWPD1_4W_QXWzxEla4b88EWo5X5/view?usp=drivesdk
27 * Raw Source: https://www.kaggle.com/datasets/imenbenyahia/clearwatervnf-virtual-ip-multimedia-ip-system
28
29
30 These models are found under *models* directory. In the below table, only the jupyter-notebooks reference is given, which can be found in *models/failure_prediction/jnotebooks* folder . The corresponding python file can be found in *models/failure_prediction/python* folder.
31
32 .. list-table:: Summary of Failure Prediction Models.
33    :widths: 25 25 25 100
34    :header-rows: 1
35
36    * - Model Name
37      - Failure type
38      - Source-File
39      - Comments
40    * - Decision Tree
41      - Virtual Machine
42      - Decision_Tree.ipynb
43      - Simplest (implementation-wise) case.
44    * - CNN
45      - Virtual Machine
46      - CNN.ipynb
47      - Convolutional Neural Network. Poorest among the Neural-network based models.
48    * - LSTM
49      - Virtual Machine
50      - LSTM.ipynb
51      - Basic Long Short-Term Memory. Better than CNN.
52    * - Attention LSTM
53      - Virtual Machine
54      - LSTM_attention.ipynb
55      - The attention mechanism distributes weights accordingly. Performance is similar to correlation LSTM.
56    * - Correlation LSTM
57      - Virtual Machine
58      - LSTM_correlation.ipynb
59      - Performs the best.
60    * - Correlation with Stacked LSTM
61      - Virtual Machine
62      - stacked_LSTM_correlation.ipynb
63      - Second best performance.
64    * - Correlation with Bi-LSTM
65      - Virtual Machine
66      - Bi_LSTMstacked_LSTM_Correlation.ipynb
67      - Third best performance.