Skip to content

Commit

Permalink
docs: regenerate API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lars-reimann committed Jun 17, 2024
1 parent 1c2d2d3 commit 0a52100
Show file tree
Hide file tree
Showing 92 changed files with 187 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/api/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
exclude: true
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

- safeds
- data
- image
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/image/containers/Image.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-class"></code> `Image` {#safeds.data.image.containers.Image data-toc-label='[class] Image'}

A container for image data.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/image/containers/ImageList.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-class"></code> `ImageList` {#safeds.data.image.containers.ImageList data-toc-label='[class] ImageList'}

An ImageList is a list of different images. It can hold different sizes of Images. The channel of all images is the same.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/image/typing/ImageSize.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-class"></code> `ImageSize` {#safeds.data.image.typing.ImageSize data-toc-label='[class] ImageSize'}

A container for image size data.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/labeled/containers/Dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Dataset` {#safeds.data.labeled.containers.Dataset data-toc-label='[class] Dataset'}

A dataset is used as input to machine learning models.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/labeled/containers/ImageDataset.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-class"></code> `ImageDataset` {#safeds.data.labeled.containers.ImageDataset data-toc-label='[class] ImageDataset'}

A Dataset for ImageLists as input and ImageLists, Tables or Columns as output.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/labeled/containers/TabularDataset.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `TabularDataset` {#safeds.data.labeled.containers.TabularDataset data-toc-label='[class] TabularDataset'}

A dataset containing tabular data. It can be used to train machine learning models.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/labeled/containers/TimeSeriesDataset.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-class"></code> `TimeSeriesDataset` {#safeds.data.labeled.containers.TimeSeriesDataset data-toc-label='[class] TimeSeriesDataset'}

A time series dataset maps feature and time columns to a target column.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/containers/Cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Cell` {#safeds.data.tabular.containers.Cell data-toc-label='[class] Cell'}

A single value in a table.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/containers/Column.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Column` {#safeds.data.tabular.containers.Column data-toc-label='[class] Column'}

A named, one-dimensional collection of homogeneous values.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/containers/Row.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Row` {#safeds.data.tabular.containers.Row data-toc-label='[class] Row'}

A one-dimensional collection of named, heterogeneous values.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/containers/StringCell.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `StringCell` {#safeds.data.tabular.containers.StringCell data-toc-label='[class] StringCell'}

Namespace for operations on strings.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/containers/Table.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Table` {#safeds.data.tabular.containers.Table data-toc-label='[class] Table'}

A two-dimensional collection of data. It can either be seen as a list of rows or as a list of columns.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/plotting/ColumnPlotter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `ColumnPlotter` {#safeds.data.tabular.plotting.ColumnPlotter data-toc-label='[class] ColumnPlotter'}

A class that contains plotting methods for a column.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/plotting/TablePlotter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `TablePlotter` {#safeds.data.tabular.plotting.TablePlotter data-toc-label='[class] TablePlotter'}

A class that contains plotting methods for a table.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/transformation/Discretizer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Discretizer` {#safeds.data.tabular.transformation.Discretizer data-toc-label='[class] Discretizer'}

The Discretizer bins continuous data into intervals.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `InvertibleTableTransformer` {#safeds.data.tabular.transformation.InvertibleTableTransformer data-toc-label='[class] InvertibleTableTransformer'}

A `TableTransformer` that can also undo the learned transformation after it has been applied.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/transformation/LabelEncoder.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `LabelEncoder` {#safeds.data.tabular.transformation.LabelEncoder data-toc-label='[class] LabelEncoder'}

The LabelEncoder encodes one or more given columns into labels.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/transformation/OneHotEncoder.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `OneHotEncoder` {#safeds.data.tabular.transformation.OneHotEncoder data-toc-label='[class] OneHotEncoder'}

A way to deal with categorical features that is particularly useful for unordered (i.e. nominal) data.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/transformation/RangeScaler.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `RangeScaler` {#safeds.data.tabular.transformation.RangeScaler data-toc-label='[class] RangeScaler'}

The RangeScaler transforms column values by scaling each value to a given range.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/transformation/SimpleImputer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `SimpleImputer` {#safeds.data.tabular.transformation.SimpleImputer data-toc-label='[class] SimpleImputer'}

Replace missing values with the given strategy.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/transformation/StandardScaler.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `StandardScaler` {#safeds.data.tabular.transformation.StandardScaler data-toc-label='[class] StandardScaler'}

The StandardScaler transforms column values to a range by removing the mean and scaling to unit variance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `TableTransformer` {#safeds.data.tabular.transformation.TableTransformer data-toc-label='[class] TableTransformer'}

Learn a transformation for a set of columns in a `Table` and transform another `Table` with the same columns.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/typing/DataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `DataType` {#safeds.data.tabular.typing.DataType data-toc-label='[class] DataType'}

The type of a column or cell in a table.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/data/tabular/typing/Schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Schema` {#safeds.data.tabular.typing.Schema data-toc-label='[class] Schema'}

The schema of a row or table.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/AnnotationTarget.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-enum"></code> `AnnotationTarget` {#safeds.lang.AnnotationTarget data-toc-label='[enum] AnnotationTarget'}

The declaration types that can be targeted by annotations.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Any.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Any` {#safeds.lang.Any data-toc-label='[class] Any'}

The common superclass of all classes.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Boolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Boolean` {#safeds.lang.Boolean data-toc-label='[class] Boolean'}

A truth value.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Category.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-annotation"></code> `Category` {#safeds.lang.Category data-toc-label='[annotation] Category'}

The category of a declaration. It can be used for grouping.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/DataScienceCategory.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-enum"></code> `DataScienceCategory` {#safeds.lang.DataScienceCategory data-toc-label='[enum] DataScienceCategory'}

A step in the data science process.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Deprecated.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-annotation"></code> `Deprecated` {#safeds.lang.Deprecated data-toc-label='[annotation] Deprecated'}

The declaration should no longer be used.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Experimental.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-annotation"></code> `Experimental` {#safeds.lang.Experimental data-toc-label='[annotation] Experimental'}

The declaration might change without a major version bump.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Expert.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-annotation"></code> `Expert` {#safeds.lang.Expert data-toc-label='[annotation] Expert'}

This parameter should only be used by expert users.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Float.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Float` {#safeds.lang.Float data-toc-label='[class] Float'}

A floating-point number.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Impure.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-annotation"></code> `Impure` {#safeds.lang.Impure data-toc-label='[annotation] Impure'}

The function has side effects and/or does not always return the same results given the same arguments.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/ImpurityReason.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-enum"></code> `ImpurityReason` {#safeds.lang.ImpurityReason data-toc-label='[enum] ImpurityReason'}

A reason why a function is impure.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Int.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Int` {#safeds.lang.Int data-toc-label='[class] Int'}

An integer.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `List` {#safeds.lang.List data-toc-label='[class] List'}

A list of elements.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Map.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Map` {#safeds.lang.Map data-toc-label='[class] Map'}

A map of keys to values.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Nothing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Nothing` {#safeds.lang.Nothing data-toc-label='[class] Nothing'}

The common subclass of all classes.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Number.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Number` {#safeds.lang.Number data-toc-label='[class] Number'}

A number.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Pure.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-annotation"></code> `Pure` {#safeds.lang.Pure data-toc-label='[annotation] Pure'}

The function has no side effects and always returns the same results given the same arguments.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/PythonMacro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-annotation"></code> `PythonMacro` {#safeds.lang.PythonMacro data-toc-label='[annotation] PythonMacro'}

The specification of the corresponding Python code. By default, the function is called as specified in the stubs.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/PythonModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-annotation"></code> `PythonModule` {#safeds.lang.PythonModule data-toc-label='[annotation] PythonModule'}

The qualified name of the corresponding Python module. By default, this is the qualified name of the package in the
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/PythonName.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-annotation"></code> `PythonName` {#safeds.lang.PythonName data-toc-label='[annotation] PythonName'}

The name of the corresponding API element in Python. By default, this is the name of the declaration in the stubs.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Repeatable.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-annotation"></code> `Repeatable` {#safeds.lang.Repeatable data-toc-label='[annotation] Repeatable'}

The annotation can be called multiple times for the same declaration.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/String.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `String` {#safeds.lang.String data-toc-label='[class] String'}

Some text.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Tags.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-annotation"></code> `Tags` {#safeds.lang.Tags data-toc-label='[annotation] Tags'}

Tags to associate with a declaration. They can be used for filtering.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/lang/Targets.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-annotation"></code> `Targets` {#safeds.lang.Targets data-toc-label='[annotation] Targets'}

The annotation must target only the specified declaration types. By default, any declaration type can be targeted.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/ml/classical/SupervisedModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `SupervisedModel` {#safeds.ml.classical.SupervisedModel data-toc-label='[class] SupervisedModel'}

A model for supervised learning tasks.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `AdaBoostClassifier` {#safeds.ml.classical.classification.AdaBoostClassifier data-toc-label='[class] AdaBoostClassifier'}

Ada Boost classification.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/safeds/ml/classical/classification/Classifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ search:
boost: 0.5
---

[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `Classifier` {#safeds.ml.classical.classification.Classifier data-toc-label='[class] Classifier'}

A model for classification tasks.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `DecisionTreeClassifier` {#safeds.ml.classical.classification.DecisionTreeClassifier data-toc-label='[class] DecisionTreeClassifier'}

Decision tree classification.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `GradientBoostingClassifier` {#safeds.ml.classical.classification.GradientBoostingClassifier data-toc-label='[class] GradientBoostingClassifier'}

Gradient boosting classification.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `KNearestNeighborsClassifier` {#safeds.ml.classical.classification.KNearestNeighborsClassifier data-toc-label='[class] KNearestNeighborsClassifier'}

K-nearest-neighbors classification.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[//]: # (DO NOT EDIT THIS FILE DIRECTLY. Instead, edit the corresponding stub file and execute `npm run docs:api`.)

# <code class="doc-symbol doc-symbol-class"></code> `LogisticClassifier` {#safeds.ml.classical.classification.LogisticClassifier data-toc-label='[class] LogisticClassifier'}

Regularized logistic regression.
Expand Down
Loading

0 comments on commit 0a52100

Please sign in to comment.