docs: fix wrong version number

f-aguzzi · Jun 4, 2024 · a0eb4e6 · a0eb4e6
1 parent c6892a9
commit a0eb4e6
Show file tree

Hide file tree

Showing 50 changed files with 21 additions and 1,262 deletions.
diff --git a/docs/cookbook_versioned_docs/version-2.0.0/structure.md b/docs/cookbook_versioned_docs/version-2.0.0/structure.md
@@ -86,7 +86,7 @@ classDiagram
 
 \
 \
-The classifiers themselves, except `LR`, all inherit from a base class called [`BaseClassifier`](/docs/base/baseclassifier) in the `base` module:
+The classifiers themselves all inherit from a base class called [`BaseClassifier`](/docs/base/baseclassifier) in the `base` module:
 
 ```mermaid
 classDiagram
@@ -108,6 +108,10 @@ classDiagram
         ...
     }
 
+    class LR {
+        ...
+    }
+
     class PLSDA {
         ...
     }
@@ -141,7 +145,13 @@ classDiagram
         __init__(...)
     }
 
+    class PCADataModel {
+        +array_scores: ndarray
+        __init__(..., array_scores)
+    }
+
     BaseDataModel *-- LLDFDataModel
+    BaseDataModel *-- PCADataModel
 ```
 
-This allows all the classifiers to use the `LLDF` data, or any other type of data as long as it follows the `BaseDataModel` template.
+This allows all the classifiers to use the `LLDF` data, dimension-reduced `PCA` data, or any other type of data as long as it follows the `BaseDataModel` template.
diff --git a/docs/cookbook_versioned_docs/version-2.1.0/case-study-classifier.md b/docs/cookbook_versioned_docs/version-2.1.0/case-study-classifier.md
diff --git a/docs/cookbook_versioned_docs/version-2.1.0/case-study-hybrid.md b/docs/cookbook_versioned_docs/version-2.1.0/case-study-hybrid.md
diff --git a/docs/cookbook_versioned_docs/version-2.1.0/case-study-realtime.md b/docs/cookbook_versioned_docs/version-2.1.0/case-study-realtime.md
diff --git a/docs/cookbook_versioned_docs/version-2.1.0/introduction.md b/docs/cookbook_versioned_docs/version-2.1.0/introduction.md
diff --git a/docs/cookbook_versioned_docs/version-2.1.0/structure.md b/docs/cookbook_versioned_docs/version-2.1.0/structure.md
diff --git a/docs/cookbook_versioned_sidebars/version-2.1.0-sidebars.json b/docs/cookbook_versioned_sidebars/version-2.1.0-sidebars.json
diff --git a/docs/cookbook_versions.json b/docs/cookbook_versions.json
@@ -1,4 +1,3 @@
 [
-  "2.1.0",
   "2.0.0"
 ]
diff --git a/docs/versioned_docs/version-2.0.0/base/baseclassifier.md b/docs/versioned_docs/version-2.0.0/base/baseclassifier.md
@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# KNN class
+# BaseClassifier class
 
 A base class from which all classifiers inherit.
 
@@ -21,13 +21,13 @@ BaseClassifier(settings: BaseSettings, data: BaseDataModel)
 ## Fields
 
 - `settings`: object of type [`KNNSettings`](/tesi/docs/knn/knnsettings). Contains the settings for
-  the `KNN` object. 
+  the `BaseClassifier` object. 
 - `data`: object of type [`BaseDataModel`](../base/basedatamodel.md). Contains the data to be analyzed.
 - `model`: a `sklearn` model from `scikit-learn`. Defaults to `None`.
 
 ## Methods
 
-- `knn(self)`: trains the k-Neighbors Analysis model
-- `predict(self, x_data)`: performs LDA prediction once the model is trained.
+- `import_model(import_path: str)`: loads a model from file
+- `export_model(export_path: str)`: exports a model to file
   - *raises*:
-    - `RuntimeError("The kNN model is not trained yet!")` if the `KNN` model hasn't been trained yet
+    - `RuntimeError("You haven't trained the model yet! You cannot export it now.")` when trying to export an untrained model
diff --git a/docs/versioned_docs/version-2.0.0/lldf/index.mdx b/docs/versioned_docs/version-2.0.0/lldf/index.mdx
@@ -27,14 +27,14 @@ classDiagram
     class LLDF {
         +LLDFSettings settings
         +Table[] tables
-        +LLDFModel | None fused_data
+        +LLDFDataModel | None fused_data
         lldf()
         -_snv()
         +export_data(export_path: str)
         __init__(settings, tables[])
     }
 
-    class LLDFModel {
+    class LLDFDataModel {
         +x_data: pd.DataFrame
         +x_train: pd.DataFrame
         +y: np.ndarray

diff --git a/docs/versioned_docs/version-2.0.0/lldf/lldfmodel.md b/docs/versioned_docs/version-2.0.0/lldf/lldfmodel.md
@@ -11,14 +11,15 @@ It inherits from the [`BaseDataModel`](../base/basedatamodel.md).
 ## Syntax
 
 ```python
-LLDFModel(x_data: pd.DataFrame, x_train: pd.DataFrame, y: pd.DataFrame)
+LLDFModel(x_data: pd.DataFrame, x_train: pd.DataFrame, y: np.ndarray)
 ```
 
 ## Fields and constructor parameters
 
 The first two are `Pandas` `DataFrame` objects:
 - `x_data`
 - `x_train`
+
 The last is a `NumPy` `ndarray`:
 - `y`
 
diff --git a/...ed_docs/version-2.1.0/pca/pcadatamodel.md → ...ed_docs/version-2.0.0/pca/pcadatamodel.md b/...ed_docs/version-2.1.0/pca/pcadatamodel.md → ...ed_docs/version-2.0.0/pca/pcadatamodel.md
diff --git a/docs/versioned_docs/version-2.1.0/base/_category_.json b/docs/versioned_docs/version-2.1.0/base/_category_.json
diff --git a/docs/versioned_docs/version-2.1.0/base/baseclassifier.md b/docs/versioned_docs/version-2.1.0/base/baseclassifier.md
diff --git a/docs/versioned_docs/version-2.1.0/base/basedatamodel.md b/docs/versioned_docs/version-2.1.0/base/basedatamodel.md
diff --git a/docs/versioned_docs/version-2.1.0/base/basesettings.md b/docs/versioned_docs/version-2.1.0/base/basesettings.md
diff --git a/docs/versioned_docs/version-2.1.0/complete-workflow.md b/docs/versioned_docs/version-2.1.0/complete-workflow.md
diff --git a/docs/versioned_docs/version-2.1.0/knn/_category_.json b/docs/versioned_docs/version-2.1.0/knn/_category_.json
diff --git a/docs/versioned_docs/version-2.1.0/knn/knn.md b/docs/versioned_docs/version-2.1.0/knn/knn.md