docs: update stdlib docs

Safe-DS · Apr 3, 2024 · 1909331 · 1909331
1 parent bca46be
commit 1909331
Show file tree

Hide file tree

Showing 20 changed files with 44 additions and 101 deletions.
diff --git a/docs/stdlib/safeds/data/tabular/typing/Schema.md b/docs/stdlib/safeds/data/tabular/typing/Schema.md
@@ -45,28 +45,6 @@ Store column names and corresponding data types for a `Table` or `Row`.
         @Pure
         @PythonName("to_dict")
         fun toDict() -> result1: Map<String, ColumnType>
-
-        /**
-         * Merge multiple schemas into one.
-         *
-         * For each type missmatch the new schema will have the least common supertype.
-         *
-         * The type hierarchy is as follows:
-         * * Anything
-         *     * RealNumber
-         *         * Integer
-         *     * Boolean
-         *     * String
-         *
-         * @param schemas the list of schemas you want to merge
-         *
-         * @result result1 the new merged schema
-         */
-        @Pure
-        @PythonName("merge_multiple_schemas")
-        static fun mergeMultipleSchemas(
-            schemas: List<Schema>
-        ) -> result1: Schema
     }
     ```
 
@@ -145,38 +123,3 @@ Return a dictionary that maps column names to column types.
     @PythonName("to_dict")
     fun toDict() -> result1: Map<String, ColumnType>
     ```
-
-## `#!sds static fun` mergeMultipleSchemas {#safeds.data.tabular.typing.Schema.mergeMultipleSchemas data-toc-label='mergeMultipleSchemas'}
-
-Merge multiple schemas into one.
-
-For each type missmatch the new schema will have the least common supertype.
-
-The type hierarchy is as follows:
-* Anything
-    * RealNumber
-        * Integer
-    * Boolean
-    * String
-
-**Parameters:**
-
-| Name | Type | Description | Default |
-|------|------|-------------|---------|
-| `schemas` | [`List<Schema>`][safeds.lang.List] | the list of schemas you want to merge | - |
-
-**Results:**
-
-| Name | Type | Description |
-|------|------|-------------|
-| `result1` | [`Schema`][safeds.data.tabular.typing.Schema] | the new merged schema |
-
-??? quote "Source code in `schema.sdsstub`"
-
-    ```sds linenums="67"
-    @Pure
-    @PythonName("merge_multiple_schemas")
-    static fun mergeMultipleSchemas(
-        schemas: List<Schema>
-    ) -> result1: Schema
-    ```
diff --git a/docs/stdlib/safeds/ml/classical/classification/AdaBoostClassifier.md b/docs/stdlib/safeds/ml/classical/classification/AdaBoostClassifier.md
@@ -14,7 +14,7 @@ Ada Boost classification.
 
 ??? quote "Source code in `ada_boost.sdsstub`"
 
-    ```sds linenums="16"
+    ```sds linenums="15"
     class AdaBoostClassifier(
         learner: Classifier = DecisionTreeClassifier(),
         @PythonName("maximum_number_of_learners") const maximumNumberOfLearners: Int = 50,
@@ -90,7 +90,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `ada_boost.sdsstub`"
 
-    ```sds linenums="46"
+    ```sds linenums="45"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/classification/DecisionTreeClassifier.md b/docs/stdlib/safeds/ml/classical/classification/DecisionTreeClassifier.md
@@ -6,7 +6,7 @@ Decision tree classification.
 
 ??? quote "Source code in `decision_tree.sdsstub`"
 
-    ```sds linenums="10"
+    ```sds linenums="9"
     class DecisionTreeClassifier() sub Classifier {
         /**
          * Create a copy of this classifier and fit it with the given training data.
@@ -44,7 +44,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `decision_tree.sdsstub`"
 
-    ```sds linenums="20"
+    ```sds linenums="19"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/classification/GradientBoostingClassifier.md b/docs/stdlib/safeds/ml/classical/classification/GradientBoostingClassifier.md
@@ -13,7 +13,7 @@ Gradient boosting classification.
 
 ??? quote "Source code in `gradient_boosting.sdsstub`"
 
-    ```sds linenums="15"
+    ```sds linenums="14"
     class GradientBoostingClassifier(
         @PythonName("number_of_trees") const numberOfTrees: Int = 100,
         @PythonName("learning_rate") const learningRate: Float = 0.1
@@ -78,7 +78,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `gradient_boosting.sdsstub`"
 
-    ```sds linenums="40"
+    ```sds linenums="39"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/classification/KNearestNeighborsClassifier.md b/docs/stdlib/safeds/ml/classical/classification/KNearestNeighborsClassifier.md
@@ -12,7 +12,7 @@ K-nearest-neighbors classification.
 
 ??? quote "Source code in `k_nearest_neighbors.sdsstub`"
 
-    ```sds linenums="13"
+    ```sds linenums="12"
     class KNearestNeighborsClassifier(
         @PythonName("number_of_neighbors") const numberOfNeighbors: Int
     ) sub Classifier where {
@@ -65,7 +65,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `k_nearest_neighbors.sdsstub`"
 
-    ```sds linenums="32"
+    ```sds linenums="31"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/classification/LogisticRegressionClassifier.md b/docs/stdlib/safeds/ml/classical/classification/LogisticRegressionClassifier.md
@@ -6,7 +6,7 @@ Regularized logistic regression.
 
 ??? quote "Source code in `logistic_regression.sdsstub`"
 
-    ```sds linenums="10"
+    ```sds linenums="9"
     class LogisticRegressionClassifier() sub Classifier {
         /**
          * Create a copy of this classifier and fit it with the given training data.
@@ -44,7 +44,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `logistic_regression.sdsstub`"
 
-    ```sds linenums="20"
+    ```sds linenums="19"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/classification/RandomForestClassifier.md b/docs/stdlib/safeds/ml/classical/classification/RandomForestClassifier.md
@@ -12,7 +12,7 @@ Random forest classification.
 
 ??? quote "Source code in `random_forest.sdsstub`"
 
-    ```sds linenums="12"
+    ```sds linenums="11"
     class RandomForestClassifier(
         @PythonName("number_of_trees") const numberOfTrees: Int = 100
     ) sub Classifier where {
@@ -65,7 +65,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `random_forest.sdsstub`"
 
-    ```sds linenums="31"
+    ```sds linenums="30"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/classification/SupportVectorMachineClassifier.md b/docs/stdlib/safeds/ml/classical/classification/SupportVectorMachineClassifier.md
@@ -13,7 +13,7 @@ Support vector machine.
 
 ??? quote "Source code in `support_vector_machine.sdsstub`"
 
-    ```sds linenums="13"
+    ```sds linenums="12"
     class SupportVectorMachineClassifier(
         const c: Float = 1.0,
         kernel: SupportVectorMachineClassifier.Kernel = SupportVectorMachineClassifier.Kernel.RadialBasisFunction
@@ -104,7 +104,7 @@ This classifier is not modified.
 
 ??? quote "Source code in `support_vector_machine.sdsstub`"
 
-    ```sds linenums="64"
+    ```sds linenums="63"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable
@@ -117,7 +117,7 @@ The kernel functions that can be used in the support vector machine.
 
 ??? quote "Source code in `support_vector_machine.sdsstub`"
 
-    ```sds linenums="22"
+    ```sds linenums="21"
     enum Kernel {
         /**
          * A linear kernel.

diff --git a/docs/stdlib/safeds/ml/classical/regression/AdaBoostRegressor.md b/docs/stdlib/safeds/ml/classical/regression/AdaBoostRegressor.md
@@ -14,7 +14,7 @@ Ada Boost regression.
 
 ??? quote "Source code in `ada_boost.sdsstub`"
 
-    ```sds linenums="16"
+    ```sds linenums="15"
     class AdaBoostRegressor(
         learner: Regressor = DecisionTreeRegressor(),
         @PythonName("maximum_number_of_learners") const maximumNumberOfLearners: Int = 50,
@@ -90,7 +90,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `ada_boost.sdsstub`"
 
-    ```sds linenums="46"
+    ```sds linenums="45"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/DecisionTreeRegressor.md b/docs/stdlib/safeds/ml/classical/regression/DecisionTreeRegressor.md
@@ -6,7 +6,7 @@ Decision tree regression.
 
 ??? quote "Source code in `decision_tree.sdsstub`"
 
-    ```sds linenums="10"
+    ```sds linenums="9"
     class DecisionTreeRegressor() sub Regressor {
         /**
          * Create a copy of this regressor and fit it with the given training data.
@@ -44,7 +44,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `decision_tree.sdsstub`"
 
-    ```sds linenums="20"
+    ```sds linenums="19"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/ElasticNetRegressor.md b/docs/stdlib/safeds/ml/classical/regression/ElasticNetRegressor.md
@@ -13,7 +13,7 @@ Elastic net regression.
 
 ??? quote "Source code in `elastic_net_regression.sdsstub`"
 
-    ```sds linenums="14"
+    ```sds linenums="13"
     class ElasticNetRegressor(
         const alpha: Float = 1.0,
         @PythonName("lasso_ratio") const lassoRatio: Float = 0.5
@@ -79,7 +79,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `elastic_net_regression.sdsstub`"
 
-    ```sds linenums="40"
+    ```sds linenums="39"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/GradientBoostingRegressor.md b/docs/stdlib/safeds/ml/classical/regression/GradientBoostingRegressor.md
@@ -13,7 +13,7 @@ Gradient boosting regression.
 
 ??? quote "Source code in `gradient_boosting.sdsstub`"
 
-    ```sds linenums="15"
+    ```sds linenums="14"
     class GradientBoostingRegressor(
         @PythonName("number_of_trees") const numberOfTrees: Int = 100,
         @PythonName("learning_rate") const learningRate: Float = 0.1
@@ -78,7 +78,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `gradient_boosting.sdsstub`"
 
-    ```sds linenums="40"
+    ```sds linenums="39"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/KNearestNeighborsRegressor.md b/docs/stdlib/safeds/ml/classical/regression/KNearestNeighborsRegressor.md
@@ -12,7 +12,7 @@ K-nearest-neighbors regression.
 
 ??? quote "Source code in `k_nearest_neighbors.sdsstub`"
 
-    ```sds linenums="13"
+    ```sds linenums="12"
     class KNearestNeighborsRegressor(
         @PythonName("number_of_neighbors") const numberOfNeighbors: Int
     ) sub Regressor where {
@@ -65,7 +65,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `k_nearest_neighbors.sdsstub`"
 
-    ```sds linenums="32"
+    ```sds linenums="31"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/LassoRegressor.md b/docs/stdlib/safeds/ml/classical/regression/LassoRegressor.md
@@ -12,7 +12,7 @@ Lasso regression.
 
 ??? quote "Source code in `lasso_regression.sdsstub`"
 
-    ```sds linenums="12"
+    ```sds linenums="11"
     class LassoRegressor(
         const alpha: Float = 1.0
     ) sub Regressor where {
@@ -65,7 +65,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `lasso_regression.sdsstub`"
 
-    ```sds linenums="31"
+    ```sds linenums="30"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/LinearRegressionRegressor.md b/docs/stdlib/safeds/ml/classical/regression/LinearRegressionRegressor.md
@@ -6,7 +6,7 @@ Linear regression.
 
 ??? quote "Source code in `linear_regression.sdsstub`"
 
-    ```sds linenums="10"
+    ```sds linenums="9"
     class LinearRegressionRegressor() sub Regressor {
         /**
          * Create a copy of this regressor and fit it with the given training data.
@@ -44,7 +44,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `linear_regression.sdsstub`"
 
-    ```sds linenums="20"
+    ```sds linenums="19"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/RandomForestRegressor.md b/docs/stdlib/safeds/ml/classical/regression/RandomForestRegressor.md
@@ -12,7 +12,7 @@ Random forest regression.
 
 ??? quote "Source code in `random_forest.sdsstub`"
 
-    ```sds linenums="12"
+    ```sds linenums="11"
     class RandomForestRegressor(
         @PythonName("number_of_trees") const numberOfTrees: Int = 100
     ) sub Regressor where {
@@ -65,7 +65,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `random_forest.sdsstub`"
 
-    ```sds linenums="31"
+    ```sds linenums="30"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/RidgeRegressor.md b/docs/stdlib/safeds/ml/classical/regression/RidgeRegressor.md
@@ -12,7 +12,7 @@ Ridge regression.
 
 ??? quote "Source code in `ridge_regression.sdsstub`"
 
-    ```sds linenums="12"
+    ```sds linenums="11"
     class RidgeRegressor(
         const alpha: Float = 1.0
     ) sub Regressor where {
@@ -65,7 +65,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `ridge_regression.sdsstub`"
 
-    ```sds linenums="31"
+    ```sds linenums="30"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable

diff --git a/docs/stdlib/safeds/ml/classical/regression/SupportVectorMachineRegressor.md b/docs/stdlib/safeds/ml/classical/regression/SupportVectorMachineRegressor.md
@@ -13,7 +13,7 @@ Support vector machine.
 
 ??? quote "Source code in `support_vector_machine.sdsstub`"
 
-    ```sds linenums="13"
+    ```sds linenums="12"
     class SupportVectorMachineRegressor(
         const c: Float = 1.0,
         kernel: SupportVectorMachineRegressor.Kernel = SupportVectorMachineRegressor.Kernel.RadialBasisFunction
@@ -104,7 +104,7 @@ This regressor is not modified.
 
 ??? quote "Source code in `support_vector_machine.sdsstub`"
 
-    ```sds linenums="64"
+    ```sds linenums="63"
     @Pure
     fun fit(
         @PythonName("training_set") trainingSet: TaggedTable
@@ -117,7 +117,7 @@ The kernel functions that can be used in the support vector machine.
 
 ??? quote "Source code in `support_vector_machine.sdsstub`"
 
-    ```sds linenums="22"
+    ```sds linenums="21"
     enum Kernel {
         /**
          * A linear kernel.