From c68c9ee7fbc09afc1afd054b7a037d002425a16b Mon Sep 17 00:00:00 2001
From: Giuseppe Bocci <61885676+GiuseppeBocci@users.noreply.github.com>
Date: Sun, 3 Sep 2023 22:33:46 +0200
Subject: [PATCH] misspelled

---
 docs/_sources/install.rst.txt | 36 +++++++++++++++++++++--------------
 docs/install.html             |  4 ++++
 docs/searchindex.js           |  2 +-
 3 files changed, 27 insertions(+), 15 deletions(-)

diff --git a/docs/_sources/install.rst.txt b/docs/_sources/install.rst.txt
index 2544c7f..4107781 100644
--- a/docs/_sources/install.rst.txt
+++ b/docs/_sources/install.rst.txt
@@ -3,32 +3,29 @@ Installation
 
 Dowload repo
 =============
-You can downoal it from: https://github.com/DEIB-GECO/NMTF-web .
+You can downoal it from: https://github.com/DEIB-GECO/nmtf-web .
 
 Or you can download it using git command:
 
 .. code-block:: console
 	
-	git clone https://github.com/DEIB-GECO/NMTF-web
+	git clone https://github.com/DEIB-GECO/nmtf-web
 	
 Or wget:
 
 .. code-block:: console
 
-	wget --no-check-certificate --content-disposition https://github.com/DEIB-GECO/NMTF-web
+	wget --no-check-certificate --content-disposition https://github.com/DEIB-GECO/nmtf-web
 
 Or curl:
 
 .. code-block:: console
 
-	curl -LJO https://github.com/DEIB-GECO/NMTF-web
+	curl -LJO https://github.com/DEIB-GECO/nmtf-web
 
 Install requirements
 =====================
-
-On your computer
------------------
-You can install web_app_nmtf directly on you device:
+You can install nmtf-web directly on you device:
 
 1. Be sure to have python 3.7 installed or you can create and eviorment with conda:
 
@@ -44,13 +41,23 @@ You can install web_app_nmtf directly on you device:
 
 	pip install -r requirements.txt
 
-In a docker container
-----------------------
-Or youc can use a docker container:
+
+In a Docker container
+=====================
+Or you can use a docker container:
+
+1. Pull the image from DockerHub:
 
 .. code-block:: console
 
-	docker load < nmtf_web.tar
+	docker pull giuseppebocci/nmtf-web:latest
+
+2. Create and start the container, mapping the port 5000 on the port 5000:
+
+.. code-block:: console
+
+	docker run -p 5000:5000 --name container_name giuseppebocci/nmtf-web
+	
 
 Run app
 ==========
@@ -58,11 +65,12 @@ If you installed requirements with pip use:
 
 .. code-block:: console
 
+	cd nmtf-web
 	python app.py
 
-If you loaded the docker map the port 5000 and run a container using:
+To start the Docker container after the first time:
 
 .. code-block:: console
 
-	docker run -p 5000:5000 nmtf_web
+	docker start -a container_name
 	
diff --git a/docs/install.html b/docs/install.html
index f3bf1f6..b64fa7f 100644
--- a/docs/install.html
+++ b/docs/install.html
@@ -136,6 +136,10 @@ <h2>In a Docker container<a class="headerlink" href="#in-a-docker-container" tit
 <section id="run-app">
 <h2>Run app<a class="headerlink" href="#run-app" title="Permalink to this heading"></a></h2>
 <p>If you installed requirements with pip use:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cd nmtf-web</span>
+<span class="go">python app.py</span>
+</pre></div>
+</div>
 <p>To start the Docker container after the first time:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">docker start -a container_name</span>
 </pre></div>
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 728f967..8c967cf 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["NMTF_link", "app", "files_management", "how_to", "index", "install", "modules", "scripts", "utils", "websocket_protocol"], "filenames": ["NMTF_link.rst", "app.rst", "files_management.rst", "how_to.rst", "index.rst", "install.rst", "modules.rst", "scripts.rst", "utils.rst", "websocket_protocol.rst"], "titles": ["NMTF_link module", "app module", "files_management module", "Parameters to be specified by the user in the setting file", "Welcome to Web App NMTF_link\u2019s documentation!", "Installation", "flaskProject", "scripts package", "utils package", "Websocket protocol"], "terms": {"ciao": [], "create_set_fil": [1, 6], "req": 1, "file": [1, 2, 4, 7, 9], "index": [1, 4, 6], "page": [1, 4], "here": 1, "i": [1, 2, 3, 7, 9], "form": 1, "submit": 1, "task": [1, 2, 9], "method": [1, 3, 7], "allow": 1, "get": [1, 2, 7], "return": [1, 2, 7], "str": [1, 2, 7], "loader": [1, 6], "showdata": [1, 6], "showimg": [1, 6], "showtxt": [1, 6], "except": [], "associationfileexcept": [], "name": [1, 2, 3, 5, 7], "messag": [], "base": [2, 7, 8], "rais": 1, "ar": [2, 3], "error": [1, 3, 7], "associ": [1, 2, 3, 7], "format": 2, "extens": 2, "attribut": [2, 7], "gener": 7, "explan": [], "settingfileexcept": [], "set": [1, 2, 4, 7], "class": [2, 7, 8], "uniqueandtim": [2, 6], "uniqu": [1, 2, 9], "object": [2, 3, 7], "add_to_heap": [2, 6], "add_to_unique_not_us": [2, 6], "check_config_fil": [2, 6], "check_fil": [2, 6], "check_request": [2, 6], "prevent": [], "do": [], "ask": [], "multipl": [], "elabor": 9, "check_uniqu": [2, 6], "create_dir": [2, 6], "get_images_list": [2, 6], "get_path": [2, 6], "get_path_img_r": [2, 6], "img_nam": 2, "get_path_result": [2, 6], "get_setting_file_nam": [2, 6], "get_standard_setting_file_nam": [2, 6], "is_file_saf": [2, 6], "is_set": 2, "new_unique_nam": [2, 6], "remove_from_unique_not_us": [2, 6], "routine_clean_heap": [2, 6], "routine_clean_uniques_not_us": [2, 6], "save_fil": [2, 6], "fals": 2, "modul": [4, 6], "client": 9, "server": 9, "open": 9, "send": 9, "unique_id": 9, "start": [5, 9], "push": 9, "notif": 9, "output": [3, 9], "close": 9, "statu": [1, 9], "code": 9, "1000": 9, "all": [2, 3, 7, 9], "ok": 9, "1002": 9, "termin": 9, "becaus": 9, "too": 9, "much": 9, "time": [2, 3, 5, 9], "pass": [1, 9], "after": [2, 5, 9], "connect": 9, "without": [3, 9], "id": 9, "1008": 9, "invalid": 9, "an": [1, 2, 3, 8, 9], "wa": [1, 2, 9], "alreadi": [2, 9], "perform": [3, 7, 9], "1011": 9, "analysi": 9, "fail": [1, 9], "check": [1, 2, 5, 9], "your": 9, "1016": 9, "possibl": 9, "from": [1, 5, 9], "creation": [1, 9], "request": 9, "search": 4, "instal": 4, "download": [1, 5], "correctli": [], "th": [], "respoitori": [], "you": 5, "can": [2, 3, 5, 7], "intal": [], "pc": [], "pip": 5, "r": 5, "requir": 4, "txt": [1, 5], "python": 5, "app": 6, "py": [], "Or": 5, "us": [1, 2, 3, 5, 9], "docker": 4, "contain": [2, 4, 7], "load": [], "web_app_nmtf": [], "tar": [], "run": [3, 4, 7], "p": 5, "5000": 5, "nmtf_link": 6, "files_manag": [4, 6], "script": [4, 6], "packag": [4, 6], "submodul": 6, "associationmatrix": [3, 6], "get_error": [6, 7], "initi": [3, 6, 7], "mask_matrix": [6, 7], "updat": [6, 7], "update_g_left": [6, 7], "update_g_right": [6, 7], "update_": [6, 7], "valid": [6, 7], "list_to_dict": [6, 7], "parse_lin": [6, 7], "suppress_stdout": [6, 7], "network": [3, 6], "get_main": [6, 7], "select_rank": [6, 7], "processassociationmatrix": 6, "add_to_den": [], "add_to_num": [], "processnetwork": 6, "runnetworkmm": [6, 7], "runnetworkr": [6, 7], "content": [5, 6], "util": [4, 6], "evaluationmetr": [6, 7, 8], "ap": [3, 6, 7, 8], "auroc": [3, 6, 7, 8], "log_rms": [6, 8], "pearson": [6, 8], "rmse": [6, 7, 8], "stopcriterion": [6, 8], "maximum_iter": [3, 6, 8], "maximum_metr": [3, 6, 8], "relative_error": [3, 6, 8], "bold": [6, 8], "filenam": [3, 7], "leftd": 7, "rightd": 7, "left_sorted_term": 7, "right_sorted_term": 7, "main": [3, 7], "rng": 7, "mask": [3, 7], "type_of_mask": 7, "verbos": 7, "initialize_strategi": 7, "metric": [3, 7], "list": [1, 2, 7], "line": [7, 9], "graph_topology_fil": 7, "dirfilenam": 7, "1": [3, 7], "ds_name": 7, "am": [], "self": [], "association_matric": 7, "g_left": [], "left": [3, 7], "arg": 7, "result": [1, 2, 3, 7], "metricsarr": 7, "po": 7, "valu": [3, 8], "enum": 8, "enumer": 8, "": 8, "dowload": 4, "repo": 4, "downoal": 5, "github": 5, "git": 5, "command": 5, "clone": 5, "http": 5, "com": 5, "deib": 5, "geco": 5, "nmtf": [3, 5], "link": [1, 3], "wget": 5, "certif": 5, "disposit": 5, "curl": 5, "ljo": 5, "directli": 5, "devic": 5, "Be": 5, "sure": 5, "have": [3, 5], "3": 5, "7": 5, "istal": [], "creat": [1, 2, 5, 7], "evior": 5, "conda": 5, "n": 5, "my_env": 5, "activ": 5, "youc": [], "If": [1, 5], "map": 5, "port": 5, "\u00f9": [], "_": 2, "print": 1, "hello": [], "flaskproject": 4, "websocket": [1, 4], "protocol": 4, "veri": 9, "simpl": 9, "The": [1, 3, 7, 9], "hi": 9, "program": 9, "thi": [1, 2, 3, 9], "diagram": 9, "2": [], "paramet": [1, 2, 4, 7], "immutablemultidict": 1, "save": [1, 2], "none": 1, "someth": 1, "went": 1, "wrong": 1, "ad": 1, "keyerror": 1, "miss": 1, "consist": 1, "indexerror": 1, "witch": 1, "handl": 1, "captcha": 1, "post": 1, "html": 1, "ha": [1, 3], "prompt": 1, "where": [1, 2], "commun": 1, "page_error": 1, "400": 1, "test": 1, "recaptcha": 1, "401": 1, "show": 1, "argument": 1, "data": [1, 7], "doesn": 1, "t": 1, "exist": [1, 2], "api": 1, "imag": [1, 2, 5], "img": 1, "as_attach": 1, "ye": 1, "attach": 1, "path": [1, 2], "node": [2, 3, 7], "heap": 2, "keep": 2, "track": 2, "file_life_": 2, "second": 2, "elimin": 2, "string": 2, "float": [2, 7], "which": [2, 3], "add": 2, "never": 2, "safe": 2, "well": 2, "filestorag": 2, "bool": 2, "true": 2, "otherwis": [2, 3, 7], "union": [2, 3, 7], "anoth": 2, "dir": 2, "doe": 2, "NOT": 2, "specif": 2, "upload_fold": 2, "secret_add": 2, "preserv": 2, "its": [2, 3, 7], "setup_fil": 2, "standard": 2, "yaml": [2, 3], "just": 2, "alphanumer": 2, "char": 2, "len": 2, "less": 2, "than": 2, "30": [], "new": 2, "lifetim": 2, "expir": 2, "remov": 2, "function": 2, "stat": 2, "routin": 2, "clean": 2, "up": 2, "call": 2, "everi": [2, 7], "routine_": 2, "routine_unique_not_us": 2, "default": [2, 7], "l": 2, "represent": 7, "graph": [3, 7], "And": 7, "instanc": 7, "each": [3, 7], "decomposit": 7, "describ": 7, "topologi": 7, "init_strategi": 7, "strategi": [3, 7], "random": [3, 7], "svd": [3, 7], "kmean": [3, 7], "integration_strategi": 7, "integr": [3, 7], "intersect": [3, 7], "int": 7, "how": 7, "0": [3, 7], "mean": 7, "fully_random": [3, 7], "random_per_row": 7, "matrix": [3, 7], "dataset": [3, 7], "dataset_k": 7, "dict": 7, "dictionari": 7, "rank": [3, 7], "ds_left": 7, "ds_right": 7, "relationship": 7, "right": [3, 7], "current": 7, "og": [], "produc": 7, "calcul": 7, "datatyp": 7, "In": [4, 7], "case": [3, 7], "k": [3, 7], "spheric": 7, "repres": [3, 7], "number": [3, 7], "cluster": 7, "compress": [3, 7], "magnitud": 7, "To": [3, 5], "prerform": 3, "evalu": [3, 7], "graph_topologi": 3, "need": 3, "It": 3, "setup": 3, "follow": 3, "mode": 3, "when": 3, "present": 3, "sever": 3, "matric": 3, "e": 3, "g": 3, "movi": 3, "three": 3, "four": 3, "multipartit": 3, "two": 3, "wai": 3, "element": 3, "either": 3, "onli": 3, "share": [3, 7], "option": 3, "least": 3, "one": 3, "factor": 3, "averag": 3, "precis": 3, "score": 3, "area": 3, "under": 3, "roc": 3, "curv": 3, "iter": [3, 7], "maximum": [3, 7], "algorithm": 3, "ani": 3, "posit": 3, "integ": [3, 7], "type": 3, "predict": 3, "choos": 3, "appli": 3, "select": 3, "complet": 3, "distribut": 3, "same": 3, "per": 3, "row": 3, "randomli": 3, "within": 3, "per_row_random": 3, "stop": 3, "criterion": 3, "5": 3, "best": [3, 7], "more": 3, "until": 3, "chosen": 3, "also": 3, "plot": 3, "directori": 3, "first": [3, 5], "rel": [3, 7], "001": 3, "last": 3, "threshold": 3, "minimum": 3, "novel": 3, "between": 3, "conta": 3, "bipartit": 3, "being": 3, "investig": 3, "dsname": 3, "k_svd": 3, "insead": 3, "compact": 3, "recommend": 3, "For": 3, "better": 3, "understand": 3, "case_studi": 3, "should": 3, "seen": 3, "specifi": 4, "user": 4, "metrix": 7, "necessari": 7, "dirname_1": 7, "dirname_2": 7, "max_it": 7, "arrai": 7, "epsilon": 7, "sampl": 7, "10": 7, "identifi": 7, "web": 5, "nmtf_web": [], "pull": 5, "dockerhub": 5, "giuseppebocci": 5, "latest": 5, "container_nam": 5}, "objects": {"": [[0, 0, 0, "-", "NMTF_link"], [1, 0, 0, "-", "app"], [2, 0, 0, "-", "files_management"], [7, 0, 0, "-", "scripts"], [8, 0, 0, "-", "utils"]], "app": [[1, 1, 1, "", "create_set_file"], [1, 1, 1, "", "index"], [1, 1, 1, "", "loader"], [1, 1, 1, "", "showdata"], [1, 1, 1, "", "showimg"], [1, 1, 1, "", "showtxt"]], "files_management": [[2, 2, 1, "", "UniqueAndTime"], [2, 1, 1, "", "add_to_heap"], [2, 1, 1, "", "add_to_unique_not_used"], [2, 1, 1, "", "check_config_file"], [2, 1, 1, "", "check_files"], [2, 1, 1, "", "check_request"], [2, 1, 1, "", "check_unique"], [2, 1, 1, "", "create_dir"], [2, 1, 1, "", "get_images_list"], [2, 1, 1, "", "get_path"], [2, 1, 1, "", "get_path_img_res"], [2, 1, 1, "", "get_path_results"], [2, 1, 1, "", "get_setting_file_name"], [2, 1, 1, "", "get_standard_setting_file_name"], [2, 1, 1, "", "is_file_safe"], [2, 1, 1, "", "new_unique_name"], [2, 1, 1, "", "remove_from_unique_not_used"], [2, 1, 1, "", "routine_clean_heap"], [2, 1, 1, "", "routine_clean_uniques_not_used"], [2, 1, 1, "", "save_file"], [2, 1, 1, "", "save_files"]], "scripts": [[7, 0, 0, "-", "AssociationMatrix"], [7, 0, 0, "-", "Network"], [7, 0, 0, "-", "processNetwork"]], "scripts.AssociationMatrix": [[7, 2, 1, "", "AssociationMatrix"], [7, 1, 1, "", "list_to_dict"], [7, 1, 1, "", "parse_line"], [7, 1, 1, "", "suppress_stdout"]], "scripts.AssociationMatrix.AssociationMatrix": [[7, 3, 1, "", "get_error"], [7, 3, 1, "", "initialize"], [7, 3, 1, "", "mask_matrix"], [7, 3, 1, "", "update"], [7, 3, 1, "", "update_G_left"], [7, 3, 1, "", "update_G_right"], [7, 3, 1, "", "update_S"], [7, 3, 1, "", "validate"]], "scripts.Network": [[7, 2, 1, "", "Network"]], "scripts.Network.Network": [[7, 3, 1, "", "get_error"], [7, 3, 1, "", "get_main"], [7, 3, 1, "", "select_rank"], [7, 3, 1, "", "update"], [7, 3, 1, "", "validate"]], "scripts.processNetwork": [[7, 1, 1, "", "runNetworkMM"], [7, 1, 1, "", "runNetworkRE"]], "utils": [[8, 0, 0, "-", "utils"]], "utils.utils": [[8, 2, 1, "", "EvaluationMetric"], [8, 2, 1, "", "StopCriterion"], [8, 1, 1, "", "bold"]], "utils.utils.EvaluationMetric": [[8, 4, 1, "", "APS"], [8, 4, 1, "", "AUROC"], [8, 4, 1, "", "LOG_RMSE"], [8, 4, 1, "", "PEARSON"], [8, 4, 1, "", "RMSE"]], "utils.utils.StopCriterion": [[8, 4, 1, "", "MAXIMUM_ITERATIONS"], [8, 4, 1, "", "MAXIMUM_METRIC"], [8, 4, 1, "", "RELATIVE_ERROR"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"nmtf_link": [0, 4], "modul": [0, 1, 2, 7, 8], "app": [1, 4, 5], "files_manag": 2, "welcom": 4, "web": 4, "": 4, "document": 4, "content": [4, 7, 8], "indic": 4, "tabl": 4, "flaskproject": 6, "script": 7, "packag": [7, 8], "submodul": [7, 8], "associationmatrix": 7, "network": 7, "processassociationmatrix": 7, "processnetwork": 7, "util": 8, "instal": 5, "dowload": 5, "repo": 5, "requir": 5, "On": [], "your": [], "comput": [], "In": 5, "docker": 5, "contain": 5, "run": 5, "websocket": 9, "protocol": 9, "paramet": 3, "specifi": 3, "user": 3, "set": 3, "file": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"flaskProject": [[6, "flaskproject"]], "Websocket protocol": [[9, "websocket-protocol"]], "files_management module": [[2, "module-files_management"]], "Welcome to Web App NMTF_link\u2019s documentation!": [[4, "welcome-to-web-app-nmtf-link-s-documentation"]], "Contents:": [[4, null]], "Indices and tables": [[4, "indices-and-tables"]], "NMTF_link module": [[0, "module-NMTF_link"]], "Submodules": [[8, "submodules"], [7, "submodules"]], "Module contents": [[8, "module-utils"], [7, "module-scripts"]], "utils package": [[8, "utils-package"]], "utils.utils module": [[8, "module-utils.utils"]], "Parameters to be specified by the user in the setting file": [[3, "parameters-to-be-specified-by-the-user-in-the-setting-file"]], "app module": [[1, "module-app"]], "Installation": [[5, "installation"]], "Dowload repo": [[5, "dowload-repo"]], "Install requirements": [[5, "install-requirements"]], "In a Docker container": [[5, "in-a-docker-container"]], "Run app": [[5, "run-app"]], "scripts package": [[7, "scripts-package"]], "scripts.AssociationMatrix module": [[7, "module-scripts.AssociationMatrix"]], "scripts.Network module": [[7, "module-scripts.Network"]], "scripts.processAssociationMatrix module": [[7, "scripts-processassociationmatrix-module"]], "scripts.processNetwork module": [[7, "module-scripts.processNetwork"]]}, "indexentries": {"associationmatrix (class in scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.AssociationMatrix"]], "network (class in scripts.network)": [[7, "scripts.Network.Network"]], "get_error() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.get_error"]], "get_error() (scripts.network.network method)": [[7, "scripts.Network.Network.get_error"]], "get_main() (scripts.network.network method)": [[7, "scripts.Network.Network.get_main"]], "initialize() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.initialize"]], "list_to_dict() (in module scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.list_to_dict"]], "mask_matrix() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.mask_matrix"]], "module": [[7, "module-scripts"], [7, "module-scripts.AssociationMatrix"], [7, "module-scripts.Network"], [7, "module-scripts.processNetwork"]], "parse_line() (in module scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.parse_line"]], "runnetworkmm() (in module scripts.processnetwork)": [[7, "scripts.processNetwork.runNetworkMM"]], "runnetworkre() (in module scripts.processnetwork)": [[7, "scripts.processNetwork.runNetworkRE"]], "scripts": [[7, "module-scripts"]], "scripts.associationmatrix": [[7, "module-scripts.AssociationMatrix"]], "scripts.network": [[7, "module-scripts.Network"]], "scripts.processnetwork": [[7, "module-scripts.processNetwork"]], "select_rank() (scripts.network.network method)": [[7, "scripts.Network.Network.select_rank"]], "suppress_stdout() (in module scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.suppress_stdout"]], "update() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update"]], "update() (scripts.network.network method)": [[7, "scripts.Network.Network.update"]], "update_g_left() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update_G_left"]], "update_g_right() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update_G_right"]], "update_s() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update_S"]], "validate() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.validate"]], "validate() (scripts.network.network method)": [[7, "scripts.Network.Network.validate"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["NMTF_link", "app", "files_management", "how_to", "index", "install", "modules", "scripts", "utils", "websocket_protocol"], "filenames": ["NMTF_link.rst", "app.rst", "files_management.rst", "how_to.rst", "index.rst", "install.rst", "modules.rst", "scripts.rst", "utils.rst", "websocket_protocol.rst"], "titles": ["NMTF_link module", "app module", "files_management module", "Parameters to be specified by the user in the setting file", "Welcome to Web App NMTF_link\u2019s documentation!", "Installation", "flaskProject", "scripts package", "utils package", "Websocket protocol"], "terms": {"ciao": [], "create_set_fil": [1, 6], "req": 1, "file": [1, 2, 4, 7, 9], "index": [1, 4, 6], "page": [1, 4], "here": 1, "i": [1, 2, 3, 7, 9], "form": 1, "submit": 1, "task": [1, 2, 9], "method": [1, 3, 7], "allow": 1, "get": [1, 2, 7], "return": [1, 2, 7], "str": [1, 2, 7], "loader": [1, 6], "showdata": [1, 6], "showimg": [1, 6], "showtxt": [1, 6], "except": [], "associationfileexcept": [], "name": [1, 2, 3, 5, 7], "messag": [], "base": [2, 7, 8], "rais": 1, "ar": [2, 3], "error": [1, 3, 7], "associ": [1, 2, 3, 7], "format": 2, "extens": 2, "attribut": [2, 7], "gener": 7, "explan": [], "settingfileexcept": [], "set": [1, 2, 4, 7], "class": [2, 7, 8], "uniqueandtim": [2, 6], "uniqu": [1, 2, 9], "object": [2, 3, 7], "add_to_heap": [2, 6], "add_to_unique_not_us": [2, 6], "check_config_fil": [2, 6], "check_fil": [2, 6], "check_request": [2, 6], "prevent": [], "do": [], "ask": [], "multipl": [], "elabor": 9, "check_uniqu": [2, 6], "create_dir": [2, 6], "get_images_list": [2, 6], "get_path": [2, 6], "get_path_img_r": [2, 6], "img_nam": 2, "get_path_result": [2, 6], "get_setting_file_nam": [2, 6], "get_standard_setting_file_nam": [2, 6], "is_file_saf": [2, 6], "is_set": 2, "new_unique_nam": [2, 6], "remove_from_unique_not_us": [2, 6], "routine_clean_heap": [2, 6], "routine_clean_uniques_not_us": [2, 6], "save_fil": [2, 6], "fals": 2, "modul": [4, 6], "client": 9, "server": 9, "open": 9, "send": 9, "unique_id": 9, "start": [5, 9], "push": 9, "notif": 9, "output": [3, 9], "close": 9, "statu": [1, 9], "code": 9, "1000": 9, "all": [2, 3, 7, 9], "ok": 9, "1002": 9, "termin": 9, "becaus": 9, "too": 9, "much": 9, "time": [2, 3, 5, 9], "pass": [1, 9], "after": [2, 5, 9], "connect": 9, "without": [3, 9], "id": 9, "1008": 9, "invalid": 9, "an": [1, 2, 3, 8, 9], "wa": [1, 2, 9], "alreadi": [2, 9], "perform": [3, 7, 9], "1011": 9, "analysi": 9, "fail": [1, 9], "check": [1, 2, 5, 9], "your": 9, "1016": 9, "possibl": 9, "from": [1, 5, 9], "creation": [1, 9], "request": 9, "search": 4, "instal": 4, "download": [1, 5], "correctli": [], "th": [], "respoitori": [], "you": 5, "can": [2, 3, 5, 7], "intal": [], "pc": [], "pip": 5, "r": 5, "requir": 4, "txt": [1, 5], "python": 5, "app": 6, "py": 5, "Or": 5, "us": [1, 2, 3, 5, 9], "docker": 4, "contain": [2, 4, 7], "load": [], "web_app_nmtf": [], "tar": [], "run": [3, 4, 7], "p": 5, "5000": 5, "nmtf_link": 6, "files_manag": [4, 6], "script": [4, 6], "packag": [4, 6], "submodul": 6, "associationmatrix": [3, 6], "get_error": [6, 7], "initi": [3, 6, 7], "mask_matrix": [6, 7], "updat": [6, 7], "update_g_left": [6, 7], "update_g_right": [6, 7], "update_": [6, 7], "valid": [6, 7], "list_to_dict": [6, 7], "parse_lin": [6, 7], "suppress_stdout": [6, 7], "network": [3, 6], "get_main": [6, 7], "select_rank": [6, 7], "processassociationmatrix": 6, "add_to_den": [], "add_to_num": [], "processnetwork": 6, "runnetworkmm": [6, 7], "runnetworkr": [6, 7], "content": [5, 6], "util": [4, 6], "evaluationmetr": [6, 7, 8], "ap": [3, 6, 7, 8], "auroc": [3, 6, 7, 8], "log_rms": [6, 8], "pearson": [6, 8], "rmse": [6, 7, 8], "stopcriterion": [6, 8], "maximum_iter": [3, 6, 8], "maximum_metr": [3, 6, 8], "relative_error": [3, 6, 8], "bold": [6, 8], "filenam": [3, 7], "leftd": 7, "rightd": 7, "left_sorted_term": 7, "right_sorted_term": 7, "main": [3, 7], "rng": 7, "mask": [3, 7], "type_of_mask": 7, "verbos": 7, "initialize_strategi": 7, "metric": [3, 7], "list": [1, 2, 7], "line": [7, 9], "graph_topology_fil": 7, "dirfilenam": 7, "1": [3, 7], "ds_name": 7, "am": [], "self": [], "association_matric": 7, "g_left": [], "left": [3, 7], "arg": 7, "result": [1, 2, 3, 7], "metricsarr": 7, "po": 7, "valu": [3, 8], "enum": 8, "enumer": 8, "": 8, "dowload": 4, "repo": 4, "downoal": 5, "github": 5, "git": 5, "command": 5, "clone": 5, "http": 5, "com": 5, "deib": 5, "geco": 5, "nmtf": [3, 5], "link": [1, 3], "wget": 5, "certif": 5, "disposit": 5, "curl": 5, "ljo": 5, "directli": 5, "devic": 5, "Be": 5, "sure": 5, "have": [3, 5], "3": 5, "7": 5, "istal": [], "creat": [1, 2, 5, 7], "evior": 5, "conda": 5, "n": 5, "my_env": 5, "activ": 5, "youc": [], "If": [1, 5], "map": 5, "port": 5, "\u00f9": [], "_": 2, "print": 1, "hello": [], "flaskproject": 4, "websocket": [1, 4], "protocol": 4, "veri": 9, "simpl": 9, "The": [1, 3, 7, 9], "hi": 9, "program": 9, "thi": [1, 2, 3, 9], "diagram": 9, "2": [], "paramet": [1, 2, 4, 7], "immutablemultidict": 1, "save": [1, 2], "none": 1, "someth": 1, "went": 1, "wrong": 1, "ad": 1, "keyerror": 1, "miss": 1, "consist": 1, "indexerror": 1, "witch": 1, "handl": 1, "captcha": 1, "post": 1, "html": 1, "ha": [1, 3], "prompt": 1, "where": [1, 2], "commun": 1, "page_error": 1, "400": 1, "test": 1, "recaptcha": 1, "401": 1, "show": 1, "argument": 1, "data": [1, 7], "doesn": 1, "t": 1, "exist": [1, 2], "api": 1, "imag": [1, 2, 5], "img": 1, "as_attach": 1, "ye": 1, "attach": 1, "path": [1, 2], "node": [2, 3, 7], "heap": 2, "keep": 2, "track": 2, "file_life_": 2, "second": 2, "elimin": 2, "string": 2, "float": [2, 7], "which": [2, 3], "add": 2, "never": 2, "safe": 2, "well": 2, "filestorag": 2, "bool": 2, "true": 2, "otherwis": [2, 3, 7], "union": [2, 3, 7], "anoth": 2, "dir": 2, "doe": 2, "NOT": 2, "specif": 2, "upload_fold": 2, "secret_add": 2, "preserv": 2, "its": [2, 3, 7], "setup_fil": 2, "standard": 2, "yaml": [2, 3], "just": 2, "alphanumer": 2, "char": 2, "len": 2, "less": 2, "than": 2, "30": [], "new": 2, "lifetim": 2, "expir": 2, "remov": 2, "function": 2, "stat": 2, "routin": 2, "clean": 2, "up": 2, "call": 2, "everi": [2, 7], "routine_": 2, "routine_unique_not_us": 2, "default": [2, 7], "l": 2, "represent": 7, "graph": [3, 7], "And": 7, "instanc": 7, "each": [3, 7], "decomposit": 7, "describ": 7, "topologi": 7, "init_strategi": 7, "strategi": [3, 7], "random": [3, 7], "svd": [3, 7], "kmean": [3, 7], "integration_strategi": 7, "integr": [3, 7], "intersect": [3, 7], "int": 7, "how": 7, "0": [3, 7], "mean": 7, "fully_random": [3, 7], "random_per_row": 7, "matrix": [3, 7], "dataset": [3, 7], "dataset_k": 7, "dict": 7, "dictionari": 7, "rank": [3, 7], "ds_left": 7, "ds_right": 7, "relationship": 7, "right": [3, 7], "current": 7, "og": [], "produc": 7, "calcul": 7, "datatyp": 7, "In": [4, 7], "case": [3, 7], "k": [3, 7], "spheric": 7, "repres": [3, 7], "number": [3, 7], "cluster": 7, "compress": [3, 7], "magnitud": 7, "To": [3, 5], "prerform": 3, "evalu": [3, 7], "graph_topologi": 3, "need": 3, "It": 3, "setup": 3, "follow": 3, "mode": 3, "when": 3, "present": 3, "sever": 3, "matric": 3, "e": 3, "g": 3, "movi": 3, "three": 3, "four": 3, "multipartit": 3, "two": 3, "wai": 3, "element": 3, "either": 3, "onli": 3, "share": [3, 7], "option": 3, "least": 3, "one": 3, "factor": 3, "averag": 3, "precis": 3, "score": 3, "area": 3, "under": 3, "roc": 3, "curv": 3, "iter": [3, 7], "maximum": [3, 7], "algorithm": 3, "ani": 3, "posit": 3, "integ": [3, 7], "type": 3, "predict": 3, "choos": 3, "appli": 3, "select": 3, "complet": 3, "distribut": 3, "same": 3, "per": 3, "row": 3, "randomli": 3, "within": 3, "per_row_random": 3, "stop": 3, "criterion": 3, "5": 3, "best": [3, 7], "more": 3, "until": 3, "chosen": 3, "also": 3, "plot": 3, "directori": 3, "first": [3, 5], "rel": [3, 7], "001": 3, "last": 3, "threshold": 3, "minimum": 3, "novel": 3, "between": 3, "conta": 3, "bipartit": 3, "being": 3, "investig": 3, "dsname": 3, "k_svd": 3, "insead": 3, "compact": 3, "recommend": 3, "For": 3, "better": 3, "understand": 3, "case_studi": 3, "should": 3, "seen": 3, "specifi": 4, "user": 4, "metrix": 7, "necessari": 7, "dirname_1": 7, "dirname_2": 7, "max_it": 7, "arrai": 7, "epsilon": 7, "sampl": 7, "10": 7, "identifi": 7, "web": 5, "nmtf_web": [], "pull": 5, "dockerhub": 5, "giuseppebocci": 5, "latest": 5, "container_nam": 5, "cd": 5}, "objects": {"": [[0, 0, 0, "-", "NMTF_link"], [1, 0, 0, "-", "app"], [2, 0, 0, "-", "files_management"], [7, 0, 0, "-", "scripts"], [8, 0, 0, "-", "utils"]], "app": [[1, 1, 1, "", "create_set_file"], [1, 1, 1, "", "index"], [1, 1, 1, "", "loader"], [1, 1, 1, "", "showdata"], [1, 1, 1, "", "showimg"], [1, 1, 1, "", "showtxt"]], "files_management": [[2, 2, 1, "", "UniqueAndTime"], [2, 1, 1, "", "add_to_heap"], [2, 1, 1, "", "add_to_unique_not_used"], [2, 1, 1, "", "check_config_file"], [2, 1, 1, "", "check_files"], [2, 1, 1, "", "check_request"], [2, 1, 1, "", "check_unique"], [2, 1, 1, "", "create_dir"], [2, 1, 1, "", "get_images_list"], [2, 1, 1, "", "get_path"], [2, 1, 1, "", "get_path_img_res"], [2, 1, 1, "", "get_path_results"], [2, 1, 1, "", "get_setting_file_name"], [2, 1, 1, "", "get_standard_setting_file_name"], [2, 1, 1, "", "is_file_safe"], [2, 1, 1, "", "new_unique_name"], [2, 1, 1, "", "remove_from_unique_not_used"], [2, 1, 1, "", "routine_clean_heap"], [2, 1, 1, "", "routine_clean_uniques_not_used"], [2, 1, 1, "", "save_file"], [2, 1, 1, "", "save_files"]], "scripts": [[7, 0, 0, "-", "AssociationMatrix"], [7, 0, 0, "-", "Network"], [7, 0, 0, "-", "processNetwork"]], "scripts.AssociationMatrix": [[7, 2, 1, "", "AssociationMatrix"], [7, 1, 1, "", "list_to_dict"], [7, 1, 1, "", "parse_line"], [7, 1, 1, "", "suppress_stdout"]], "scripts.AssociationMatrix.AssociationMatrix": [[7, 3, 1, "", "get_error"], [7, 3, 1, "", "initialize"], [7, 3, 1, "", "mask_matrix"], [7, 3, 1, "", "update"], [7, 3, 1, "", "update_G_left"], [7, 3, 1, "", "update_G_right"], [7, 3, 1, "", "update_S"], [7, 3, 1, "", "validate"]], "scripts.Network": [[7, 2, 1, "", "Network"]], "scripts.Network.Network": [[7, 3, 1, "", "get_error"], [7, 3, 1, "", "get_main"], [7, 3, 1, "", "select_rank"], [7, 3, 1, "", "update"], [7, 3, 1, "", "validate"]], "scripts.processNetwork": [[7, 1, 1, "", "runNetworkMM"], [7, 1, 1, "", "runNetworkRE"]], "utils": [[8, 0, 0, "-", "utils"]], "utils.utils": [[8, 2, 1, "", "EvaluationMetric"], [8, 2, 1, "", "StopCriterion"], [8, 1, 1, "", "bold"]], "utils.utils.EvaluationMetric": [[8, 4, 1, "", "APS"], [8, 4, 1, "", "AUROC"], [8, 4, 1, "", "LOG_RMSE"], [8, 4, 1, "", "PEARSON"], [8, 4, 1, "", "RMSE"]], "utils.utils.StopCriterion": [[8, 4, 1, "", "MAXIMUM_ITERATIONS"], [8, 4, 1, "", "MAXIMUM_METRIC"], [8, 4, 1, "", "RELATIVE_ERROR"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"nmtf_link": [0, 4], "modul": [0, 1, 2, 7, 8], "app": [1, 4, 5], "files_manag": 2, "welcom": 4, "web": 4, "": 4, "document": 4, "content": [4, 7, 8], "indic": 4, "tabl": 4, "flaskproject": 6, "script": 7, "packag": [7, 8], "submodul": [7, 8], "associationmatrix": 7, "network": 7, "processassociationmatrix": 7, "processnetwork": 7, "util": 8, "instal": 5, "dowload": 5, "repo": 5, "requir": 5, "On": [], "your": [], "comput": [], "In": 5, "docker": 5, "contain": 5, "run": 5, "websocket": 9, "protocol": 9, "paramet": 3, "specifi": 3, "user": 3, "set": 3, "file": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"flaskProject": [[6, "flaskproject"]], "Websocket protocol": [[9, "websocket-protocol"]], "files_management module": [[2, "module-files_management"]], "Welcome to Web App NMTF_link\u2019s documentation!": [[4, "welcome-to-web-app-nmtf-link-s-documentation"]], "Contents:": [[4, null]], "Indices and tables": [[4, "indices-and-tables"]], "NMTF_link module": [[0, "module-NMTF_link"]], "Submodules": [[8, "submodules"], [7, "submodules"]], "Module contents": [[8, "module-utils"], [7, "module-scripts"]], "utils package": [[8, "utils-package"]], "utils.utils module": [[8, "module-utils.utils"]], "Parameters to be specified by the user in the setting file": [[3, "parameters-to-be-specified-by-the-user-in-the-setting-file"]], "app module": [[1, "module-app"]], "Installation": [[5, "installation"]], "Dowload repo": [[5, "dowload-repo"]], "Install requirements": [[5, "install-requirements"]], "In a Docker container": [[5, "in-a-docker-container"]], "Run app": [[5, "run-app"]], "scripts package": [[7, "scripts-package"]], "scripts.AssociationMatrix module": [[7, "module-scripts.AssociationMatrix"]], "scripts.Network module": [[7, "module-scripts.Network"]], "scripts.processAssociationMatrix module": [[7, "scripts-processassociationmatrix-module"]], "scripts.processNetwork module": [[7, "module-scripts.processNetwork"]]}, "indexentries": {"associationmatrix (class in scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.AssociationMatrix"]], "network (class in scripts.network)": [[7, "scripts.Network.Network"]], "get_error() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.get_error"]], "get_error() (scripts.network.network method)": [[7, "scripts.Network.Network.get_error"]], "get_main() (scripts.network.network method)": [[7, "scripts.Network.Network.get_main"]], "initialize() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.initialize"]], "list_to_dict() (in module scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.list_to_dict"]], "mask_matrix() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.mask_matrix"]], "module": [[7, "module-scripts"], [7, "module-scripts.AssociationMatrix"], [7, "module-scripts.Network"], [7, "module-scripts.processNetwork"]], "parse_line() (in module scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.parse_line"]], "runnetworkmm() (in module scripts.processnetwork)": [[7, "scripts.processNetwork.runNetworkMM"]], "runnetworkre() (in module scripts.processnetwork)": [[7, "scripts.processNetwork.runNetworkRE"]], "scripts": [[7, "module-scripts"]], "scripts.associationmatrix": [[7, "module-scripts.AssociationMatrix"]], "scripts.network": [[7, "module-scripts.Network"]], "scripts.processnetwork": [[7, "module-scripts.processNetwork"]], "select_rank() (scripts.network.network method)": [[7, "scripts.Network.Network.select_rank"]], "suppress_stdout() (in module scripts.associationmatrix)": [[7, "scripts.AssociationMatrix.suppress_stdout"]], "update() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update"]], "update() (scripts.network.network method)": [[7, "scripts.Network.Network.update"]], "update_g_left() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update_G_left"]], "update_g_right() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update_G_right"]], "update_s() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.update_S"]], "validate() (scripts.associationmatrix.associationmatrix method)": [[7, "scripts.AssociationMatrix.AssociationMatrix.validate"]], "validate() (scripts.network.network method)": [[7, "scripts.Network.Network.validate"]]}})
\ No newline at end of file