Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: integrate version 0.24.0 of the safe-ds Python library #1162

Merged
merged 5 commits into from
May 9, 2024
Merged

feat: integrate version 0.24.0 of the safe-ds Python library #1162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4687840
feat: stubs for new library version
lars-reimann May 9, 2024
fb4ab06
feat: require new runner version
lars-reimann May 9, 2024
666e028
fix: codegen of expression lambdas
lars-reimann May 9, 2024
eb8137a
docs: regenerate API docs
lars-reimann May 9, 2024
ee7eece
test: regenerate snapshots
lars-reimann May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion docs/api/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,36 @@ search:
- containers
- [Image](safeds/data/image/containers/Image.md)
- [ImageList](safeds/data/image/containers/ImageList.md)
- typing
- [ImageSize](safeds/data/image/typing/ImageSize.md)
- labeled
- containers
- [ExperimentalTabularDataset](safeds/data/labeled/containers/ExperimentalTabularDataset.md)
- [ImageDataset](safeds/data/labeled/containers/ImageDataset.md)
- [TabularDataset](safeds/data/labeled/containers/TabularDataset.md)
- [TimeSeriesDataset](safeds/data/labeled/containers/TimeSeriesDataset.md)
- tabular
- containers
- [Column](safeds/data/tabular/containers/Column.md)
- [ExperimentalCell](safeds/data/tabular/containers/ExperimentalCell.md)
- [ExperimentalColumn](safeds/data/tabular/containers/ExperimentalColumn.md)
- [ExperimentalRow](safeds/data/tabular/containers/ExperimentalRow.md)
- [ExperimentalTable](safeds/data/tabular/containers/ExperimentalTable.md)
- [Row](safeds/data/tabular/containers/Row.md)
- [Table](safeds/data/tabular/containers/Table.md)
- [TimeSeries](safeds/data/tabular/containers/TimeSeries.md)
- plotting
- [ExperimentalColumnPlotter](safeds/data/tabular/plotting/ExperimentalColumnPlotter.md)
- [ExperimentalTablePlotter](safeds/data/tabular/plotting/ExperimentalTablePlotter.md)
- transformation
- [Discretizer](safeds/data/tabular/transformation/Discretizer.md)
- [ExperimentalDiscretizer](safeds/data/tabular/transformation/ExperimentalDiscretizer.md)
- [ExperimentalInvertibleTableTransformer](safeds/data/tabular/transformation/ExperimentalInvertibleTableTransformer.md)
- [ExperimentalLabelEncoder](safeds/data/tabular/transformation/ExperimentalLabelEncoder.md)
- [ExperimentalOneHotEncoder](safeds/data/tabular/transformation/ExperimentalOneHotEncoder.md)
- [ExperimentalRangeScaler](safeds/data/tabular/transformation/ExperimentalRangeScaler.md)
- [ExperimentalSimpleImputer](safeds/data/tabular/transformation/ExperimentalSimpleImputer.md)
- [ExperimentalStandardScaler](safeds/data/tabular/transformation/ExperimentalStandardScaler.md)
- [ExperimentalTableTransformer](safeds/data/tabular/transformation/ExperimentalTableTransformer.md)
- [Imputer](safeds/data/tabular/transformation/Imputer.md)
- [InvertibleTableTransformer](safeds/data/tabular/transformation/InvertibleTableTransformer.md)
- [LabelEncoder](safeds/data/tabular/transformation/LabelEncoder.md)
Expand All @@ -29,6 +48,8 @@ search:
- [TableTransformer](safeds/data/tabular/transformation/TableTransformer.md)
- typing
- [ColumnType](safeds/data/tabular/typing/ColumnType.md)
- [ExperimentalDataType](safeds/data/tabular/typing/ExperimentalDataType.md)
- [ExperimentalSchema](safeds/data/tabular/typing/ExperimentalSchema.md)
- [Schema](safeds/data/tabular/typing/Schema.md)
- lang
- [AnnotationTarget](safeds/lang/AnnotationTarget.md)
Expand Down Expand Up @@ -80,11 +101,23 @@ search:
- [RidgeRegressor](safeds/ml/classical/regression/RidgeRegressor.md)
- [SupportVectorMachineRegressor](safeds/ml/classical/regression/SupportVectorMachineRegressor.md)
- nn
- [AvgPooling2DLayer](safeds/ml/nn/AvgPooling2DLayer.md)
- [Convolutional2DLayer](safeds/ml/nn/Convolutional2DLayer.md)
- [ConvolutionalTranspose2DLayer](safeds/ml/nn/ConvolutionalTranspose2DLayer.md)
- [FlattenLayer](safeds/ml/nn/FlattenLayer.md)
- [ForwardLayer](safeds/ml/nn/ForwardLayer.md)
- [InputConversion](safeds/ml/nn/InputConversion.md)
- [InputConversionImage](safeds/ml/nn/InputConversionImage.md)
- [InputConversionTable](safeds/ml/nn/InputConversionTable.md)
- [InputConversionTimeSeries](safeds/ml/nn/InputConversionTimeSeries.md)
- [Layer](safeds/ml/nn/Layer.md)
- [LSTMLayer](safeds/ml/nn/LSTMLayer.md)
- [MaxPooling2DLayer](safeds/ml/nn/MaxPooling2DLayer.md)
- [NeuralNetworkClassifier](safeds/ml/nn/NeuralNetworkClassifier.md)
- [NeuralNetworkRegressor](safeds/ml/nn/NeuralNetworkRegressor.md)
- [OutputConversion](safeds/ml/nn/OutputConversion.md)
- [OutputConversionImageToColumn](safeds/ml/nn/OutputConversionImageToColumn.md)
- [OutputConversionImageToImage](safeds/ml/nn/OutputConversionImageToImage.md)
- [OutputConversionImageToTable](safeds/ml/nn/OutputConversionImageToTable.md)
- [OutputConversionTable](safeds/ml/nn/OutputConversionTable.md)
- [OutputConversionTimeSeries](safeds/ml/nn/OutputConversionTimeSeries.md)
101 changes: 55 additions & 46 deletions docs/api/safeds/data/image/containers/Image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `#!sds abstract class` Image {#safeds.data.image.containers.Image data-toc-label='Image'}
# :test_tube:{ title="Experimental" } `#!sds abstract class` Image {#safeds.data.image.containers.Image data-toc-label='Image'}

A container for image data.

Expand All @@ -10,9 +10,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="11"
```sds linenums="14"
class Image {
/**
* Get the width of the image in pixels.
Expand Down Expand Up @@ -41,14 +41,17 @@ pipeline example {
* }
*/
attr channel: Int
/**
* Get the `ImageSize` of the image.
*/
attr size: ImageSize

/**
* Create an image from a file.
*
* @param path The path to the image file.
* @param device The device where the tensor will be saved on. Defaults to the default device
*
* @result result1 The image.
* @result image The image.
*
* @example
* pipeline example {
Expand All @@ -59,7 +62,7 @@ pipeline example {
@PythonName("from_file")
static fun fromFile(
path: String
) -> result1: Image
) -> image: Image

/**
* Save the image as a JPEG file.
Expand Down Expand Up @@ -448,6 +451,12 @@ pipeline example {
}
```

## `#!sds attr` size {#safeds.data.image.containers.Image.size data-toc-label='size'}

Get the `ImageSize` of the image.

**Type:** [`ImageSize`][safeds.data.image.typing.ImageSize]

## `#!sds attr` width {#safeds.data.image.containers.Image.width data-toc-label='width'}

Get the width of the image in pixels.
Expand Down Expand Up @@ -488,9 +497,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="248"
```sds linenums="254"
@Pure
@PythonName("add_noise")
fun addNoise(
Expand Down Expand Up @@ -526,9 +535,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="226"
```sds linenums="232"
@Pure
@PythonName("adjust_brightness")
fun adjustBrightness(
Expand Down Expand Up @@ -564,9 +573,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="298"
```sds linenums="304"
@Pure
@PythonName("adjust_color_balance")
fun adjustColorBalance(
Expand Down Expand Up @@ -602,9 +611,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="273"
```sds linenums="279"
@Pure
@PythonName("adjust_contrast")
fun adjustContrast(
Expand Down Expand Up @@ -640,9 +649,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="321"
```sds linenums="327"
@Pure
fun blur(
const radius: Int
Expand All @@ -669,9 +678,9 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image with the given number of channels. |

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="100"
```sds linenums="106"
@Pure
@PythonName("change_channel")
fun changeChannel(
Expand Down Expand Up @@ -699,9 +708,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="142"
```sds linenums="148"
@Pure
@PythonName("convert_to_grayscale")
fun convertToGrayscale() -> result1: Image
Expand Down Expand Up @@ -736,9 +745,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="163"
```sds linenums="169"
@Pure
fun crop(
const x: Int,
Expand Down Expand Up @@ -773,9 +782,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="412"
```sds linenums="418"
@Pure
@PythonName("find_edges")
fun findEdges() -> result1: Image
Expand All @@ -801,9 +810,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="204"
```sds linenums="210"
@Pure
@PythonName("flip_horizontally")
fun flipHorizontally() -> result1: Image
Expand All @@ -829,9 +838,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="188"
```sds linenums="194"
@Pure
@PythonName("flip_vertically")
fun flipVertically() -> result1: Image
Expand All @@ -857,9 +866,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="364"
```sds linenums="370"
@Pure
@PythonName("invert_colors")
fun invertColors() -> result1: Image
Expand Down Expand Up @@ -892,9 +901,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="121"
```sds linenums="127"
@Pure
fun resize(
@PythonName("new_width") const newWidth: Int,
Expand Down Expand Up @@ -925,9 +934,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="396"
```sds linenums="402"
@Pure
@PythonName("rotate_left")
fun rotateLeft() -> result1: Image
Expand All @@ -953,9 +962,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="380"
```sds linenums="386"
@Pure
@PythonName("rotate_right")
fun rotateRight() -> result1: Image
Expand Down Expand Up @@ -987,9 +996,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="345"
```sds linenums="351"
@Pure
fun sharpen(
const factor: Float
Expand All @@ -1016,9 +1025,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="69"
```sds linenums="75"
@Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
@PythonName("to_jpeg_file")
fun toJpegFile(
Expand All @@ -1044,9 +1053,9 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="85"
```sds linenums="91"
@Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
@PythonName("to_png_file")
fun toPngFile(
Expand All @@ -1068,7 +1077,7 @@ Create an image from a file.

| Name | Type | Description |
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image. |
| `image` | [`Image`][safeds.data.image.containers.Image] | The image. |

**Examples:**

Expand All @@ -1078,12 +1087,12 @@ pipeline example {
}
```

??? quote "Stub code in `image.sdsstub`"
??? quote "Stub code in `Image.sdsstub`"

```sds linenums="53"
```sds linenums="59"
@Impure([ImpurityReason.FileReadFromParameterizedPath("path")])
@PythonName("from_file")
static fun fromFile(
path: String
) -> result1: Image
) -> image: Image
```
Loading