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

Jump to bottom

feat(deps): require latest runner (v0.11.0) #1058

Merged
merged 8 commits into from
Apr 17, 2024
Merged

feat(deps): require latest runner (v0.11.0) #1058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8a4f993
build: bump runner to at least `v0.11.0`
lars-reimann Apr 17, 2024
eef675a
feat: stubs for ARIMA
lars-reimann Apr 17, 2024
e3127ba
feat: stubs for improve layers
lars-reimann Apr 17, 2024
ad9e82b
feat: stubs for `changeChannel`
lars-reimann Apr 17, 2024
19edbf0
feat: stubs for `ImageList`
lars-reimann Apr 17, 2024
2389ef2
feat: final polish
lars-reimann Apr 17, 2024
4400a2f
docs: regenerate API reference
lars-reimann Apr 17, 2024
ae7b82a
fix: make `ImageList` abstract
lars-reimann Apr 17, 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
5 changes: 4 additions & 1 deletion docs/api/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ search:
- image
- containers
- [Image](safeds/data/image/containers/Image.md)
- [ImageList](safeds/data/image/containers/ImageList.md)
- tabular
- containers
- [Column](safeds/data/tabular/containers/Column.md)
Expand Down Expand Up @@ -62,6 +63,7 @@ search:
- [SupportVectorMachineClassifier](safeds/ml/classical/classification/SupportVectorMachineClassifier.md)
- regression
- [AdaBoostRegressor](safeds/ml/classical/regression/AdaBoostRegressor.md)
- [ArimaRegressor](safeds/ml/classical/regression/ArimaRegressor.md)
- [DecisionTreeRegressor](safeds/ml/classical/regression/DecisionTreeRegressor.md)
- [ElasticNetRegressor](safeds/ml/classical/regression/ElasticNetRegressor.md)
- [GradientBoostingRegressor](safeds/ml/classical/regression/GradientBoostingRegressor.md)
Expand All @@ -73,6 +75,7 @@ search:
- [RidgeRegressor](safeds/ml/classical/regression/RidgeRegressor.md)
- [SupportVectorMachineRegressor](safeds/ml/classical/regression/SupportVectorMachineRegressor.md)
- nn
- [FNNLayer](safeds/ml/nn/FNNLayer.md)
- [ForwardLayer](safeds/ml/nn/ForwardLayer.md)
- [Layer](safeds/ml/nn/Layer.md)
- [NeuralNetworkClassifier](safeds/ml/nn/NeuralNetworkClassifier.md)
- [NeuralNetworkRegressor](safeds/ml/nn/NeuralNetworkRegressor.md)
73 changes: 58 additions & 15 deletions docs/api/safeds/data/image/containers/Image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,21 @@ A container for image data.
path: String
)

/**
* Return a new `Image` that has the given number of channels.
*
* The original image is not modified.
*
* @param channel The new number of channels. 1 will result in a grayscale image.
*
* @result result1 The image with the given number of channels.
*/
@Pure
@PythonName("change_channel")
fun changeChannel(
channel: Int
) -> result1: Image

/**
* Return a new `Image` that has been resized to a given size.
*
Expand Down Expand Up @@ -330,7 +345,7 @@ The original image is not modified.

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

```sds linenums="163"
```sds linenums="178"
@Pure
@PythonName("add_noise")
fun addNoise(
Expand Down Expand Up @@ -360,7 +375,7 @@ The original image is not modified.

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

```sds linenums="146"
```sds linenums="161"
@Pure
@PythonName("adjust_brightness")
fun adjustBrightness(
Expand Down Expand Up @@ -390,7 +405,7 @@ The original image is not modified.

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

```sds linenums="203"
```sds linenums="218"
@Pure
@PythonName("adjust_color_balance")
fun adjustColorBalance(
Expand Down Expand Up @@ -420,7 +435,7 @@ The original image is not modified.

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

```sds linenums="183"
```sds linenums="198"
@Pure
@PythonName("adjust_contrast")
fun adjustContrast(
Expand Down Expand Up @@ -450,7 +465,7 @@ The original image is not modified.

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

```sds linenums="221"
```sds linenums="236"
@Pure
fun blur(
const radius: Int
Expand All @@ -459,6 +474,34 @@ The original image is not modified.
}
```

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

Return a new `Image` that has the given number of channels.

The original image is not modified.

**Parameters:**

| Name | Type | Description | Default |
|------|------|-------------|---------|
| `channel` | [`Int`][safeds.lang.Int] | The new number of channels. 1 will result in a grayscale image. | - |

**Results:**

| Name | Type | Description |
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image with the given number of channels. |

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

```sds linenums="65"
@Pure
@PythonName("change_channel")
fun changeChannel(
channel: Int
) -> result1: Image
```

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

Return a new `Image` that is converted to grayscale.
Expand All @@ -473,7 +516,7 @@ The original image is not modified.

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

```sds linenums="82"
```sds linenums="97"
@Pure
@PythonName("convert_to_grayscale")
fun convertToGrayscale() -> result1: Image
Expand Down Expand Up @@ -502,7 +545,7 @@ The original image is not modified.

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

```sds linenums="98"
```sds linenums="113"
@Pure
fun crop(
const x: Int,
Expand Down Expand Up @@ -531,7 +574,7 @@ The original image is not modified.

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

```sds linenums="287"
```sds linenums="302"
@Pure
@PythonName("find_edges")
fun findEdges() -> result1: Image
Expand All @@ -551,7 +594,7 @@ The original image is not modified.

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

```sds linenums="129"
```sds linenums="144"
@Pure
@PythonName("flip_horizontally")
fun flipHorizontally() -> result1: Image
Expand All @@ -571,7 +614,7 @@ The original image is not modified.

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

```sds linenums="118"
```sds linenums="133"
@Pure
@PythonName("flip_vertically")
fun flipVertically() -> result1: Image
Expand All @@ -591,7 +634,7 @@ The original image is not modified.

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

```sds linenums="254"
```sds linenums="269"
@Pure
@PythonName("invert_colors")
fun invertColors() -> result1: Image
Expand All @@ -618,7 +661,7 @@ The original image is not modified.

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

```sds linenums="66"
```sds linenums="81"
@Pure
fun resize(
@PythonName("new_width") const newWidth: Int,
Expand All @@ -643,7 +686,7 @@ The original image is not modified.

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

```sds linenums="276"
```sds linenums="291"
@Pure
@PythonName("rotate_left")
fun rotateLeft() -> result1: Image
Expand All @@ -663,7 +706,7 @@ The original image is not modified.

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

```sds linenums="265"
```sds linenums="280"
@Pure
@PythonName("rotate_right")
fun rotateRight() -> result1: Image
Expand All @@ -689,7 +732,7 @@ The original image is not modified.

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

```sds linenums="240"
```sds linenums="255"
@Pure
fun sharpen(
const factor: Float
Expand Down
Loading