diff --git a/docs/api/safeds/data/image/containers/Image.md b/docs/api/safeds/data/image/containers/Image.md index 1babb894c..694b14c82 100644 --- a/docs/api/safeds/data/image/containers/Image.md +++ b/docs/api/safeds/data/image/containers/Image.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds abstract class` `Image` {#safeds.data.image.containers.Image data-toc-label='[abstract class] Image'} +# :test_tube:{ title="Experimental" } `Image` {#safeds.data.image.containers.Image data-toc-label='[class] Image'} A container for image data. @@ -423,7 +423,7 @@ pipeline example { } ``` -## `#!sds attr` `channel` {#safeds.data.image.containers.Image.channel data-toc-label='[attr] channel'} +## `channel` {#safeds.data.image.containers.Image.channel data-toc-label='[attribute] channel'} Get the number of channels of the image. @@ -437,7 +437,7 @@ pipeline example { } ``` -## `#!sds attr` `height` {#safeds.data.image.containers.Image.height data-toc-label='[attr] height'} +## `height` {#safeds.data.image.containers.Image.height data-toc-label='[attribute] height'} Get the height of the image in pixels. @@ -451,13 +451,13 @@ pipeline example { } ``` -## `#!sds attr` `size` {#safeds.data.image.containers.Image.size data-toc-label='[attr] size'} +## `size` {#safeds.data.image.containers.Image.size data-toc-label='[attribute] 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='[attr] width'} +## `width` {#safeds.data.image.containers.Image.width data-toc-label='[attribute] width'} Get the width of the image in pixels. @@ -471,7 +471,7 @@ pipeline example { } ``` -## `#!sds fun` `addNoise` {#safeds.data.image.containers.Image.addNoise data-toc-label='[fun] addNoise'} +## `addNoise` {#safeds.data.image.containers.Image.addNoise data-toc-label='[function] addNoise'} Return a new `Image` with noise added to the image. @@ -509,7 +509,7 @@ pipeline example { } ``` -## `#!sds fun` `adjustBrightness` {#safeds.data.image.containers.Image.adjustBrightness data-toc-label='[fun] adjustBrightness'} +## `adjustBrightness` {#safeds.data.image.containers.Image.adjustBrightness data-toc-label='[function] adjustBrightness'} Return a new `Image` with an adjusted brightness. @@ -547,7 +547,7 @@ pipeline example { } ``` -## `#!sds fun` `adjustColorBalance` {#safeds.data.image.containers.Image.adjustColorBalance data-toc-label='[fun] adjustColorBalance'} +## `adjustColorBalance` {#safeds.data.image.containers.Image.adjustColorBalance data-toc-label='[function] adjustColorBalance'} Return a new `Image` with adjusted color balance. @@ -585,7 +585,7 @@ pipeline example { } ``` -## `#!sds fun` `adjustContrast` {#safeds.data.image.containers.Image.adjustContrast data-toc-label='[fun] adjustContrast'} +## `adjustContrast` {#safeds.data.image.containers.Image.adjustContrast data-toc-label='[function] adjustContrast'} Return a new `Image` with adjusted contrast. @@ -623,7 +623,7 @@ pipeline example { } ``` -## `#!sds fun` `blur` {#safeds.data.image.containers.Image.blur data-toc-label='[fun] blur'} +## `blur` {#safeds.data.image.containers.Image.blur data-toc-label='[function] blur'} Return a blurred version of the image. @@ -660,7 +660,7 @@ pipeline example { } ``` -## `#!sds fun` `changeChannel` {#safeds.data.image.containers.Image.changeChannel data-toc-label='[fun] changeChannel'} +## `changeChannel` {#safeds.data.image.containers.Image.changeChannel data-toc-label='[function] changeChannel'} Return a new `Image` that has the given number of channels. @@ -688,7 +688,7 @@ The original image is not modified. ) -> result1: Image ``` -## `#!sds fun` `convertToGrayscale` {#safeds.data.image.containers.Image.convertToGrayscale data-toc-label='[fun] convertToGrayscale'} +## `convertToGrayscale` {#safeds.data.image.containers.Image.convertToGrayscale data-toc-label='[function] convertToGrayscale'} Return a new `Image` that is converted to grayscale. @@ -716,7 +716,7 @@ pipeline example { fun convertToGrayscale() -> result1: Image ``` -## `#!sds fun` `crop` {#safeds.data.image.containers.Image.crop data-toc-label='[fun] crop'} +## `crop` {#safeds.data.image.containers.Image.crop data-toc-label='[function] crop'} Return a new `Image` that has been cropped to a given bounding rectangle. @@ -762,7 +762,7 @@ pipeline example { } ``` -## `#!sds fun` `findEdges` {#safeds.data.image.containers.Image.findEdges data-toc-label='[fun] findEdges'} +## `findEdges` {#safeds.data.image.containers.Image.findEdges data-toc-label='[function] findEdges'} Return a grayscale version of the image with the edges highlighted. @@ -790,7 +790,7 @@ pipeline example { fun findEdges() -> result1: Image ``` -## `#!sds fun` `flipHorizontally` {#safeds.data.image.containers.Image.flipHorizontally data-toc-label='[fun] flipHorizontally'} +## `flipHorizontally` {#safeds.data.image.containers.Image.flipHorizontally data-toc-label='[function] flipHorizontally'} Return a new `Image` that is flipped horizontally (vertical axis, flips left-right and vice versa). @@ -818,7 +818,7 @@ pipeline example { fun flipHorizontally() -> result1: Image ``` -## `#!sds fun` `flipVertically` {#safeds.data.image.containers.Image.flipVertically data-toc-label='[fun] flipVertically'} +## `flipVertically` {#safeds.data.image.containers.Image.flipVertically data-toc-label='[function] flipVertically'} Return a new `Image` that is flipped vertically (horizontal axis, flips up-down and vice versa). @@ -846,7 +846,7 @@ pipeline example { fun flipVertically() -> result1: Image ``` -## `#!sds fun` `invertColors` {#safeds.data.image.containers.Image.invertColors data-toc-label='[fun] invertColors'} +## `invertColors` {#safeds.data.image.containers.Image.invertColors data-toc-label='[function] invertColors'} Return a new `Image` with colors inverted. @@ -874,7 +874,7 @@ pipeline example { fun invertColors() -> result1: Image ``` -## `#!sds fun` `resize` {#safeds.data.image.containers.Image.resize data-toc-label='[fun] resize'} +## `resize` {#safeds.data.image.containers.Image.resize data-toc-label='[function] resize'} Return a new `Image` that has been resized to a given size. @@ -914,7 +914,7 @@ pipeline example { } ``` -## `#!sds fun` `rotateLeft` {#safeds.data.image.containers.Image.rotateLeft data-toc-label='[fun] rotateLeft'} +## `rotateLeft` {#safeds.data.image.containers.Image.rotateLeft data-toc-label='[function] rotateLeft'} Return a new `Image` that is rotated 90 degrees counter-clockwise. @@ -942,7 +942,7 @@ pipeline example { fun rotateLeft() -> result1: Image ``` -## `#!sds fun` `rotateRight` {#safeds.data.image.containers.Image.rotateRight data-toc-label='[fun] rotateRight'} +## `rotateRight` {#safeds.data.image.containers.Image.rotateRight data-toc-label='[function] rotateRight'} Return a new `Image` that is rotated 90 degrees clockwise. @@ -970,7 +970,7 @@ pipeline example { fun rotateRight() -> result1: Image ``` -## `#!sds fun` `sharpen` {#safeds.data.image.containers.Image.sharpen data-toc-label='[fun] sharpen'} +## `sharpen` {#safeds.data.image.containers.Image.sharpen data-toc-label='[function] sharpen'} Return a sharpened version of the image. @@ -1007,7 +1007,7 @@ pipeline example { } ``` -## `#!sds fun` `toJpegFile` {#safeds.data.image.containers.Image.toJpegFile data-toc-label='[fun] toJpegFile'} +## `toJpegFile` {#safeds.data.image.containers.Image.toJpegFile data-toc-label='[function] toJpegFile'} Save the image as a JPEG file. @@ -1035,7 +1035,7 @@ pipeline example { ) ``` -## `#!sds fun` `toPngFile` {#safeds.data.image.containers.Image.toPngFile data-toc-label='[fun] toPngFile'} +## `toPngFile` {#safeds.data.image.containers.Image.toPngFile data-toc-label='[function] toPngFile'} Save the image as a PNG file. @@ -1063,7 +1063,7 @@ pipeline example { ) ``` -## `#!sds static fun` `fromFile` {#safeds.data.image.containers.Image.fromFile data-toc-label='[static fun] fromFile'} +## `fromFile` {#safeds.data.image.containers.Image.fromFile data-toc-label='[static-function] fromFile'} Create an image from a file. diff --git a/docs/api/safeds/data/image/containers/ImageList.md b/docs/api/safeds/data/image/containers/ImageList.md index 0ee264ecf..8b705ad2b 100644 --- a/docs/api/safeds/data/image/containers/ImageList.md +++ b/docs/api/safeds/data/image/containers/ImageList.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds abstract class` `ImageList` {#safeds.data.image.containers.ImageList data-toc-label='[abstract class] ImageList'} +# :test_tube:{ title="Experimental" } `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. @@ -513,43 +513,43 @@ To create an `ImageList` call one of the following static methods: } ``` -## `#!sds attr` `channel` {#safeds.data.image.containers.ImageList.channel data-toc-label='[attr] channel'} +## `channel` {#safeds.data.image.containers.ImageList.channel data-toc-label='[attribute] channel'} Return the channel of all images. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `heights` {#safeds.data.image.containers.ImageList.heights data-toc-label='[attr] heights'} +## `heights` {#safeds.data.image.containers.ImageList.heights data-toc-label='[attribute] heights'} Return a list of all heights in this image list. **Type:** [`List`][safeds.lang.List] -## `#!sds attr` `imageCount` {#safeds.data.image.containers.ImageList.imageCount data-toc-label='[attr] imageCount'} +## `imageCount` {#safeds.data.image.containers.ImageList.imageCount data-toc-label='[attribute] imageCount'} Return the number of images in this image list. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `sizeCount` {#safeds.data.image.containers.ImageList.sizeCount data-toc-label='[attr] sizeCount'} +## `sizeCount` {#safeds.data.image.containers.ImageList.sizeCount data-toc-label='[attribute] sizeCount'} Return the number of different sizes of images in this image list. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `sizes` {#safeds.data.image.containers.ImageList.sizes data-toc-label='[attr] sizes'} +## `sizes` {#safeds.data.image.containers.ImageList.sizes data-toc-label='[attribute] sizes'} Return the sizes of all images. **Type:** [`List`][safeds.lang.List] -## `#!sds attr` `widths` {#safeds.data.image.containers.ImageList.widths data-toc-label='[attr] widths'} +## `widths` {#safeds.data.image.containers.ImageList.widths data-toc-label='[attribute] widths'} Return a list of all widths in this image list. **Type:** [`List`][safeds.lang.List] -## `#!sds fun` `addImage` {#safeds.data.image.containers.ImageList.addImage data-toc-label='[fun] addImage'} +## `addImage` {#safeds.data.image.containers.ImageList.addImage data-toc-label='[function] addImage'} Return a new `ImageList` with the given image added to the image list. @@ -577,7 +577,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `addImages` {#safeds.data.image.containers.ImageList.addImages data-toc-label='[fun] addImages'} +## `addImages` {#safeds.data.image.containers.ImageList.addImages data-toc-label='[function] addImages'} Return a new `ImageList` with the given images added to the image list. @@ -605,7 +605,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `addNoise` {#safeds.data.image.containers.ImageList.addNoise data-toc-label='[fun] addNoise'} +## `addNoise` {#safeds.data.image.containers.ImageList.addNoise data-toc-label='[function] addNoise'} Return a new `ImageList` with noise added to all images. @@ -635,7 +635,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `adjustBrightness` {#safeds.data.image.containers.ImageList.adjustBrightness data-toc-label='[fun] adjustBrightness'} +## `adjustBrightness` {#safeds.data.image.containers.ImageList.adjustBrightness data-toc-label='[function] adjustBrightness'} Return a new `ImageList` where all images have the adjusted brightness. @@ -665,7 +665,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `adjustColorBalance` {#safeds.data.image.containers.ImageList.adjustColorBalance data-toc-label='[fun] adjustColorBalance'} +## `adjustColorBalance` {#safeds.data.image.containers.ImageList.adjustColorBalance data-toc-label='[function] adjustColorBalance'} Return a new `ImageList` where all images have the adjusted color balance. @@ -695,7 +695,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `adjustContrast` {#safeds.data.image.containers.ImageList.adjustContrast data-toc-label='[fun] adjustContrast'} +## `adjustContrast` {#safeds.data.image.containers.ImageList.adjustContrast data-toc-label='[function] adjustContrast'} Return a new `ImageList` where all images have the adjusted contrast. @@ -725,7 +725,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `blur` {#safeds.data.image.containers.ImageList.blur data-toc-label='[fun] blur'} +## `blur` {#safeds.data.image.containers.ImageList.blur data-toc-label='[function] blur'} Return a new `ImageList` where all images have been blurred. @@ -754,7 +754,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `changeChannel` {#safeds.data.image.containers.ImageList.changeChannel data-toc-label='[fun] changeChannel'} +## `changeChannel` {#safeds.data.image.containers.ImageList.changeChannel data-toc-label='[function] changeChannel'} Return a new `ImageList` that has the given number of channels. @@ -782,7 +782,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `convertToGrayscale` {#safeds.data.image.containers.ImageList.convertToGrayscale data-toc-label='[fun] convertToGrayscale'} +## `convertToGrayscale` {#safeds.data.image.containers.ImageList.convertToGrayscale data-toc-label='[function] convertToGrayscale'} Return a new `ImageList` with all images converted to grayscale. @@ -802,7 +802,7 @@ The original image list is not modified. fun convertToGrayscale() -> imageList: ImageList ``` -## `#!sds fun` `crop` {#safeds.data.image.containers.ImageList.crop data-toc-label='[fun] crop'} +## `crop` {#safeds.data.image.containers.ImageList.crop data-toc-label='[function] crop'} Return a new `ImageList` with all images cropped to a given bounding rectangle. @@ -840,7 +840,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `findEdges` {#safeds.data.image.containers.ImageList.findEdges data-toc-label='[fun] findEdges'} +## `findEdges` {#safeds.data.image.containers.ImageList.findEdges data-toc-label='[function] findEdges'} Return a new `ImageList` with grayscale versions of the images with the edges highlighted. @@ -860,7 +860,7 @@ The original image list is not modified. fun findEdges() -> imageList: ImageList ``` -## `#!sds fun` `flipHorizontally` {#safeds.data.image.containers.ImageList.flipHorizontally data-toc-label='[fun] flipHorizontally'} +## `flipHorizontally` {#safeds.data.image.containers.ImageList.flipHorizontally data-toc-label='[function] flipHorizontally'} Return a new `ImageList` with all images flipped horizontally (vertical axis, flips left-right and vice versa). @@ -880,7 +880,7 @@ The original image list is not modified. fun flipHorizontally() -> imageList: ImageList ``` -## `#!sds fun` `flipVertically` {#safeds.data.image.containers.ImageList.flipVertically data-toc-label='[fun] flipVertically'} +## `flipVertically` {#safeds.data.image.containers.ImageList.flipVertically data-toc-label='[function] flipVertically'} Return a new `ImageList` with all images flipped vertically (horizontal axis, flips up-down and vice versa). @@ -900,7 +900,7 @@ The original image list is not modified. fun flipVertically() -> imageList: ImageList ``` -## `#!sds fun` `getImage` {#safeds.data.image.containers.ImageList.getImage data-toc-label='[fun] getImage'} +## `getImage` {#safeds.data.image.containers.ImageList.getImage data-toc-label='[function] getImage'} Return the image at the given index. @@ -926,7 +926,7 @@ Return the image at the given index. ) -> image: Image ``` -## `#!sds fun` `hasImage` {#safeds.data.image.containers.ImageList.hasImage data-toc-label='[fun] hasImage'} +## `hasImage` {#safeds.data.image.containers.ImageList.hasImage data-toc-label='[function] hasImage'} Return whether the given image is in this image list. @@ -952,7 +952,7 @@ Return whether the given image is in this image list. ) -> hasImage: Boolean ``` -## `#!sds fun` `index` {#safeds.data.image.containers.ImageList.index data-toc-label='[fun] index'} +## `index` {#safeds.data.image.containers.ImageList.index data-toc-label='[function] index'} Return a list of indexes of the given image. @@ -979,7 +979,7 @@ If the image has multiple occurrences, all indices will be returned ) -> indices: List ``` -## `#!sds fun` `invertColors` {#safeds.data.image.containers.ImageList.invertColors data-toc-label='[fun] invertColors'} +## `invertColors` {#safeds.data.image.containers.ImageList.invertColors data-toc-label='[function] invertColors'} Return a new `ImageList` where all images have their colors inverted. @@ -999,7 +999,7 @@ The original image list is not modified. fun invertColors() -> imageList: ImageList ``` -## `#!sds fun` `removeDuplicateImages` {#safeds.data.image.containers.ImageList.removeDuplicateImages data-toc-label='[fun] removeDuplicateImages'} +## `removeDuplicateImages` {#safeds.data.image.containers.ImageList.removeDuplicateImages data-toc-label='[function] removeDuplicateImages'} Return a new `ImageList` with all duplicate images removed. @@ -1021,7 +1021,7 @@ The original image list is not modified. fun removeDuplicateImages() -> imageList: ImageList ``` -## `#!sds fun` `removeImage` {#safeds.data.image.containers.ImageList.removeImage data-toc-label='[fun] removeImage'} +## `removeImage` {#safeds.data.image.containers.ImageList.removeImage data-toc-label='[function] removeImage'} Return a new `ImageList` with the given image removed from the image list. @@ -1051,7 +1051,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `removeImageByIndex` {#safeds.data.image.containers.ImageList.removeImageByIndex data-toc-label='[fun] removeImageByIndex'} +## `removeImageByIndex` {#safeds.data.image.containers.ImageList.removeImageByIndex data-toc-label='[function] removeImageByIndex'} Return a new `ImageList` with the given indices removed from the image list. @@ -1079,7 +1079,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `removeImages` {#safeds.data.image.containers.ImageList.removeImages data-toc-label='[fun] removeImages'} +## `removeImages` {#safeds.data.image.containers.ImageList.removeImages data-toc-label='[function] removeImages'} Return a new `ImageList` with the given images removed from the image list. @@ -1109,7 +1109,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `removeImagesWithSize` {#safeds.data.image.containers.ImageList.removeImagesWithSize data-toc-label='[fun] removeImagesWithSize'} +## `removeImagesWithSize` {#safeds.data.image.containers.ImageList.removeImagesWithSize data-toc-label='[function] removeImagesWithSize'} Return a new `ImageList` with the all images of the given size removed. @@ -1139,7 +1139,7 @@ The original image list is not modified. ) -> imageList: ImageList ``` -## `#!sds fun` `resize` {#safeds.data.image.containers.ImageList.resize data-toc-label='[fun] resize'} +## `resize` {#safeds.data.image.containers.ImageList.resize data-toc-label='[function] resize'} Return a new `ImageList` with all images resized to a given size. @@ -1171,7 +1171,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `rotateLeft` {#safeds.data.image.containers.ImageList.rotateLeft data-toc-label='[fun] rotateLeft'} +## `rotateLeft` {#safeds.data.image.containers.ImageList.rotateLeft data-toc-label='[function] rotateLeft'} Return a new `ImageList` where all images have been rotated 90 degrees counter-clockwise. @@ -1191,7 +1191,7 @@ The original image list is not modified. fun rotateLeft() -> imageList: ImageList ``` -## `#!sds fun` `rotateRight` {#safeds.data.image.containers.ImageList.rotateRight data-toc-label='[fun] rotateRight'} +## `rotateRight` {#safeds.data.image.containers.ImageList.rotateRight data-toc-label='[function] rotateRight'} Return a new `ImageList` where all images have been rotated 90 degrees clockwise. @@ -1211,7 +1211,7 @@ The original image list is not modified. fun rotateRight() -> imageList: ImageList ``` -## `#!sds fun` `sharpen` {#safeds.data.image.containers.ImageList.sharpen data-toc-label='[fun] sharpen'} +## `sharpen` {#safeds.data.image.containers.ImageList.sharpen data-toc-label='[function] sharpen'} Return a new `ImageList` where all images have been sharpened. @@ -1240,7 +1240,7 @@ The original image list is not modified. } ``` -## `#!sds fun` `shuffleImages` {#safeds.data.image.containers.ImageList.shuffleImages data-toc-label='[fun] shuffleImages'} +## `shuffleImages` {#safeds.data.image.containers.ImageList.shuffleImages data-toc-label='[function] shuffleImages'} Return a new `ImageList` with all images shuffled. @@ -1260,7 +1260,7 @@ The original image list is not modified. fun shuffleImages() -> imageList: ImageList ``` -## `#!sds fun` `toImages` {#safeds.data.image.containers.ImageList.toImages data-toc-label='[fun] toImages'} +## `toImages` {#safeds.data.image.containers.ImageList.toImages data-toc-label='[function] toImages'} Return a list of all images in this image list. @@ -1286,7 +1286,7 @@ Return a list of all images in this image list. ) -> images: List ``` -## `#!sds fun` `toJpegFiles` {#safeds.data.image.containers.ImageList.toJpegFiles data-toc-label='[fun] toJpegFiles'} +## `toJpegFiles` {#safeds.data.image.containers.ImageList.toJpegFiles data-toc-label='[function] toJpegFiles'} Save all images as jpeg files. @@ -1306,7 +1306,7 @@ Save all images as jpeg files. ) ``` -## `#!sds fun` `toPngFiles` {#safeds.data.image.containers.ImageList.toPngFiles data-toc-label='[fun] toPngFiles'} +## `toPngFiles` {#safeds.data.image.containers.ImageList.toPngFiles data-toc-label='[function] toPngFiles'} Save all images as png files. @@ -1326,7 +1326,7 @@ Save all images as png files. ) ``` -## `#!sds static fun` `fromFiles` {#safeds.data.image.containers.ImageList.fromFiles data-toc-label='[static fun] fromFiles'} +## `fromFiles` {#safeds.data.image.containers.ImageList.fromFiles data-toc-label='[static-function] fromFiles'} Create an ImageList from a directory or a list of files. @@ -1354,7 +1354,7 @@ If you provide a path to a directory the images will be sorted alphabetically wh ) -> imageList: ImageList ``` -## `#!sds static fun` `fromImages` {#safeds.data.image.containers.ImageList.fromImages data-toc-label='[static fun] fromImages'} +## `fromImages` {#safeds.data.image.containers.ImageList.fromImages data-toc-label='[static-function] fromImages'} Create an ImageList from a list of images. diff --git a/docs/api/safeds/data/image/typing/ImageSize.md b/docs/api/safeds/data/image/typing/ImageSize.md index 17884dc12..66d1da467 100644 --- a/docs/api/safeds/data/image/typing/ImageSize.md +++ b/docs/api/safeds/data/image/typing/ImageSize.md @@ -1,4 +1,4 @@ -# `#!sds class` `ImageSize` {#safeds.data.image.typing.ImageSize data-toc-label='[class] ImageSize'} +# `ImageSize` {#safeds.data.image.typing.ImageSize data-toc-label='[class] ImageSize'} A container for image size data. @@ -48,25 +48,25 @@ A container for image size data. } ``` -## `#!sds attr` `channel` {#safeds.data.image.typing.ImageSize.channel data-toc-label='[attr] channel'} +## `channel` {#safeds.data.image.typing.ImageSize.channel data-toc-label='[attribute] channel'} Get the channel of this `ImageSize` in pixels. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `height` {#safeds.data.image.typing.ImageSize.height data-toc-label='[attr] height'} +## `height` {#safeds.data.image.typing.ImageSize.height data-toc-label='[attribute] height'} Get the height of this `ImageSize` in pixels. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `width` {#safeds.data.image.typing.ImageSize.width data-toc-label='[attr] width'} +## `width` {#safeds.data.image.typing.ImageSize.width data-toc-label='[attribute] width'} Get the width of this `ImageSize` in pixels. **Type:** [`Int`][safeds.lang.Int] -## `#!sds static fun` `fromImage` {#safeds.data.image.typing.ImageSize.fromImage data-toc-label='[static fun] fromImage'} +## `fromImage` {#safeds.data.image.typing.ImageSize.fromImage data-toc-label='[static-function] fromImage'} Create a `ImageSize` of a given image. diff --git a/docs/api/safeds/data/labeled/containers/Dataset.md b/docs/api/safeds/data/labeled/containers/Dataset.md index a188a4e39..a0465a92d 100644 --- a/docs/api/safeds/data/labeled/containers/Dataset.md +++ b/docs/api/safeds/data/labeled/containers/Dataset.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Dataset` {#safeds.data.labeled.containers.Dataset data-toc-label='[abstract class] Dataset'} +# `Dataset` {#safeds.data.labeled.containers.Dataset data-toc-label='[class] Dataset'} A dataset is used as input to machine learning models. diff --git a/docs/api/safeds/data/labeled/containers/ImageDataset.md b/docs/api/safeds/data/labeled/containers/ImageDataset.md index c92a0a55b..d2ca754d7 100644 --- a/docs/api/safeds/data/labeled/containers/ImageDataset.md +++ b/docs/api/safeds/data/labeled/containers/ImageDataset.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `ImageDataset` {#safeds.data.labeled.containers.ImageDataset data-toc-label='[class] ImageDataset'} +# :test_tube:{ title="Experimental" } `ImageDataset` {#safeds.data.labeled.containers.ImageDataset data-toc-label='[class] ImageDataset'} A Dataset for ImageLists as input and ImageLists, Tables or Columns as output. @@ -67,19 +67,19 @@ A Dataset for ImageLists as input and ImageLists, Tables or Columns as output. } ``` -## `#!sds attr` `inputSize` {#safeds.data.labeled.containers.ImageDataset.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.data.labeled.containers.ImageDataset.inputSize data-toc-label='[attribute] inputSize'} Get the input `ImageSize` of this dataset. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds attr` `outputSize` {#safeds.data.labeled.containers.ImageDataset.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.data.labeled.containers.ImageDataset.outputSize data-toc-label='[attribute] outputSize'} Get the output size of this dataset. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds fun` `getInput` {#safeds.data.labeled.containers.ImageDataset.getInput data-toc-label='[fun] getInput'} +## `getInput` {#safeds.data.labeled.containers.ImageDataset.getInput data-toc-label='[function] getInput'} Get the input data of this dataset. @@ -97,7 +97,7 @@ Get the input data of this dataset. fun getInput() -> input: ImageList ``` -## `#!sds fun` `getOutput` {#safeds.data.labeled.containers.ImageDataset.getOutput data-toc-label='[fun] getOutput'} +## `getOutput` {#safeds.data.labeled.containers.ImageDataset.getOutput data-toc-label='[function] getOutput'} Get the output data of this dataset. @@ -115,7 +115,7 @@ Get the output data of this dataset. fun getOutput() -> output: T ``` -## `#!sds fun` `shuffle` {#safeds.data.labeled.containers.ImageDataset.shuffle data-toc-label='[fun] shuffle'} +## `shuffle` {#safeds.data.labeled.containers.ImageDataset.shuffle data-toc-label='[function] shuffle'} Return a new `ImageDataset` with shuffled data. diff --git a/docs/api/safeds/data/labeled/containers/TabularDataset.md b/docs/api/safeds/data/labeled/containers/TabularDataset.md index f8232f96e..37be167fc 100644 --- a/docs/api/safeds/data/labeled/containers/TabularDataset.md +++ b/docs/api/safeds/data/labeled/containers/TabularDataset.md @@ -1,4 +1,4 @@ -# `#!sds class` `TabularDataset` {#safeds.data.labeled.containers.TabularDataset data-toc-label='[class] TabularDataset'} +# `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. @@ -71,7 +71,7 @@ pipeline example { } ``` -## `#!sds attr` `extras` {#safeds.data.labeled.containers.TabularDataset.extras data-toc-label='[attr] extras'} +## `extras` {#safeds.data.labeled.containers.TabularDataset.extras data-toc-label='[attribute] extras'} Additional columns of the tabular dataset that are neither features nor target. @@ -79,19 +79,19 @@ These can be used to store additional information about instances, such as IDs. **Type:** [`Table`][safeds.data.tabular.containers.Table] -## `#!sds attr` `features` {#safeds.data.labeled.containers.TabularDataset.features data-toc-label='[attr] features'} +## `features` {#safeds.data.labeled.containers.TabularDataset.features data-toc-label='[attribute] features'} The feature columns of the tabular dataset. **Type:** [`Table`][safeds.data.tabular.containers.Table] -## `#!sds attr` `target` {#safeds.data.labeled.containers.TabularDataset.target data-toc-label='[attr] target'} +## `target` {#safeds.data.labeled.containers.TabularDataset.target data-toc-label='[attribute] target'} The target column of the tabular dataset. **Type:** [`Column`][safeds.data.tabular.containers.Column] -## `#!sds fun` `toTable` {#safeds.data.labeled.containers.TabularDataset.toTable data-toc-label='[fun] toTable'} +## `toTable` {#safeds.data.labeled.containers.TabularDataset.toTable data-toc-label='[function] toTable'} Return a table containing all columns of the tabular dataset. diff --git a/docs/api/safeds/data/labeled/containers/TimeSeriesDataset.md b/docs/api/safeds/data/labeled/containers/TimeSeriesDataset.md index f712f06b5..707818ee9 100644 --- a/docs/api/safeds/data/labeled/containers/TimeSeriesDataset.md +++ b/docs/api/safeds/data/labeled/containers/TimeSeriesDataset.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `TimeSeriesDataset` {#safeds.data.labeled.containers.TimeSeriesDataset data-toc-label='[class] TimeSeriesDataset'} +# :test_tube:{ title="Experimental" } `TimeSeriesDataset` {#safeds.data.labeled.containers.TimeSeriesDataset data-toc-label='[class] TimeSeriesDataset'} A time series dataset maps feature and time columns to a target column. Not like the TabularDataset a TimeSeries needs to contain one target and one time column, but can have empty features. @@ -68,7 +68,7 @@ pipeline example { } ``` -## `#!sds attr` `extras` {#safeds.data.labeled.containers.TimeSeriesDataset.extras data-toc-label='[attr] extras'} +## `extras` {#safeds.data.labeled.containers.TimeSeriesDataset.extras data-toc-label='[attribute] extras'} Additional columns of the time series dataset that are neither features, target nor time. @@ -76,25 +76,25 @@ These can be used to store additional information about instances, such as IDs. **Type:** [`Table`][safeds.data.tabular.containers.Table] -## `#!sds attr` `features` {#safeds.data.labeled.containers.TimeSeriesDataset.features data-toc-label='[attr] features'} +## `features` {#safeds.data.labeled.containers.TimeSeriesDataset.features data-toc-label='[attribute] features'} The feature columns of the time series dataset. **Type:** [`Table`][safeds.data.tabular.containers.Table] -## `#!sds attr` `target` {#safeds.data.labeled.containers.TimeSeriesDataset.target data-toc-label='[attr] target'} +## `target` {#safeds.data.labeled.containers.TimeSeriesDataset.target data-toc-label='[attribute] target'} The target column of the time series dataset. **Type:** [`Column`][safeds.data.tabular.containers.Column] -## `#!sds attr` `time` {#safeds.data.labeled.containers.TimeSeriesDataset.time data-toc-label='[attr] time'} +## `time` {#safeds.data.labeled.containers.TimeSeriesDataset.time data-toc-label='[attribute] time'} The time column of the time series dataset. **Type:** [`Column`][safeds.data.tabular.containers.Column] -## `#!sds fun` `toTable` {#safeds.data.labeled.containers.TimeSeriesDataset.toTable data-toc-label='[fun] toTable'} +## `toTable` {#safeds.data.labeled.containers.TimeSeriesDataset.toTable data-toc-label='[function] toTable'} Return a new `Table` containing the feature columns, the target column, the time column and the extra columns. diff --git a/docs/api/safeds/data/tabular/containers/Cell.md b/docs/api/safeds/data/tabular/containers/Cell.md index 945457792..1a67e14dc 100644 --- a/docs/api/safeds/data/tabular/containers/Cell.md +++ b/docs/api/safeds/data/tabular/containers/Cell.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Cell` {#safeds.data.tabular.containers.Cell data-toc-label='[abstract class] Cell'} +# `Cell` {#safeds.data.tabular.containers.Cell data-toc-label='[class] Cell'} A single value in a table. @@ -299,7 +299,7 @@ This class cannot be instantiated directly. It is only used for arguments of cal } ``` -## `#!sds fun` `abs` {#safeds.data.tabular.containers.Cell.abs data-toc-label='[fun] abs'} +## `abs` {#safeds.data.tabular.containers.Cell.abs data-toc-label='[function] abs'} Get the absolute value. @@ -326,7 +326,7 @@ pipeline example { fun abs() -> result: Cell ``` -## `#!sds fun` `add` {#safeds.data.tabular.containers.Cell.add data-toc-label='[fun] add'} +## `add` {#safeds.data.tabular.containers.Cell.add data-toc-label='[function] add'} Add a value. This WILL LATER BE equivalent to the `+` operator. @@ -361,7 +361,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `and` {#safeds.data.tabular.containers.Cell.and data-toc-label='[fun] and'} +## `and` {#safeds.data.tabular.containers.Cell.and data-toc-label='[function] and'} Perform a boolean AND operation. This WILL LATER BE equivalent to the ^and operator. @@ -397,7 +397,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `ceil` {#safeds.data.tabular.containers.Cell.ceil data-toc-label='[fun] ceil'} +## `ceil` {#safeds.data.tabular.containers.Cell.ceil data-toc-label='[function] ceil'} Round up to the nearest integer. @@ -424,7 +424,7 @@ pipeline example { fun ceil() -> result: Cell ``` -## `#!sds fun` `div` {#safeds.data.tabular.containers.Cell.div data-toc-label='[fun] div'} +## `div` {#safeds.data.tabular.containers.Cell.div data-toc-label='[function] div'} Divide by a value. This WILL LATER BE equivalent to the `/` operator. @@ -459,7 +459,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `eq` {#safeds.data.tabular.containers.Cell.eq data-toc-label='[fun] eq'} +## `eq` {#safeds.data.tabular.containers.Cell.eq data-toc-label='[function] eq'} Check if equal to a value. This WILL LATER BE equivalent to the `==` operator. @@ -494,7 +494,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `floor` {#safeds.data.tabular.containers.Cell.floor data-toc-label='[fun] floor'} +## `floor` {#safeds.data.tabular.containers.Cell.floor data-toc-label='[function] floor'} Round down to the nearest integer. @@ -521,7 +521,7 @@ pipeline example { fun floor() -> result: Cell ``` -## `#!sds fun` `ge` {#safeds.data.tabular.containers.Cell.ge data-toc-label='[fun] ge'} +## `ge` {#safeds.data.tabular.containers.Cell.ge data-toc-label='[function] ge'} Check if greater than or equal to a value. This WILL LATER BE equivalent to the `>=` operator. @@ -556,7 +556,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `gt` {#safeds.data.tabular.containers.Cell.gt data-toc-label='[fun] gt'} +## `gt` {#safeds.data.tabular.containers.Cell.gt data-toc-label='[function] gt'} Check if greater than a value. This WILL LATER BE equivalent to the `>` operator. @@ -591,7 +591,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `le` {#safeds.data.tabular.containers.Cell.le data-toc-label='[fun] le'} +## `le` {#safeds.data.tabular.containers.Cell.le data-toc-label='[function] le'} Check if less than or equal to a value. This WILL LATER BE equivalent to the `<=` operator. @@ -626,7 +626,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `lt` {#safeds.data.tabular.containers.Cell.lt data-toc-label='[fun] lt'} +## `lt` {#safeds.data.tabular.containers.Cell.lt data-toc-label='[function] lt'} Check if less than a value. This WILL LATER BE equivalent to the `<` operator. @@ -661,7 +661,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `mod` {#safeds.data.tabular.containers.Cell.mod data-toc-label='[fun] mod'} +## `mod` {#safeds.data.tabular.containers.Cell.mod data-toc-label='[function] mod'} Perform a modulo operation. @@ -696,7 +696,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `mul` {#safeds.data.tabular.containers.Cell.mul data-toc-label='[fun] mul'} +## `mul` {#safeds.data.tabular.containers.Cell.mul data-toc-label='[function] mul'} Multiply by a value. This WILL LATER BE equivalent to the `*` operator. @@ -731,7 +731,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `neg` {#safeds.data.tabular.containers.Cell.neg data-toc-label='[fun] neg'} +## `neg` {#safeds.data.tabular.containers.Cell.neg data-toc-label='[function] neg'} Negate the value. @@ -758,7 +758,7 @@ pipeline example { fun neg() -> result: Cell ``` -## `#!sds fun` `not` {#safeds.data.tabular.containers.Cell.not data-toc-label='[fun] not'} +## `not` {#safeds.data.tabular.containers.Cell.not data-toc-label='[function] not'} Negate a boolean. This WILL LATER BE equivalent to the ^not operator. @@ -786,7 +786,7 @@ pipeline example { fun ^not() -> result: Cell ``` -## `#!sds fun` `or` {#safeds.data.tabular.containers.Cell.or data-toc-label='[fun] or'} +## `or` {#safeds.data.tabular.containers.Cell.or data-toc-label='[function] or'} Perform a boolean OR operation. This WILL LATER BE equivalent to the ^or operator. @@ -822,7 +822,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `pow` {#safeds.data.tabular.containers.Cell.pow data-toc-label='[fun] pow'} +## `pow` {#safeds.data.tabular.containers.Cell.pow data-toc-label='[function] pow'} Raise to a power. @@ -857,7 +857,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `sub` {#safeds.data.tabular.containers.Cell.sub data-toc-label='[fun] sub'} +## `sub` {#safeds.data.tabular.containers.Cell.sub data-toc-label='[function] sub'} Subtract a value. This WILL LATER BE equivalent to the `-` operator. @@ -892,7 +892,7 @@ pipeline example { ) -> result: Cell ``` -## `#!sds fun` `xor` {#safeds.data.tabular.containers.Cell.xor data-toc-label='[fun] xor'} +## `xor` {#safeds.data.tabular.containers.Cell.xor data-toc-label='[function] xor'} Perform a boolean XOR operation. diff --git a/docs/api/safeds/data/tabular/containers/Column.md b/docs/api/safeds/data/tabular/containers/Column.md index a6bdd1c8a..9e18f8f77 100644 --- a/docs/api/safeds/data/tabular/containers/Column.md +++ b/docs/api/safeds/data/tabular/containers/Column.md @@ -1,4 +1,4 @@ -# `#!sds class` `Column` {#safeds.data.tabular.containers.Column data-toc-label='[class] Column'} +# `Column` {#safeds.data.tabular.containers.Column data-toc-label='[class] Column'} A named, one-dimensional collection of homogeneous values. @@ -398,43 +398,43 @@ pipeline example { } ``` -## `#!sds attr` `isNumeric` {#safeds.data.tabular.containers.Column.isNumeric data-toc-label='[attr] isNumeric'} +## `isNumeric` {#safeds.data.tabular.containers.Column.isNumeric data-toc-label='[attribute] isNumeric'} Whether the column is numeric. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `isTemporal` {#safeds.data.tabular.containers.Column.isTemporal data-toc-label='[attr] isTemporal'} +## `isTemporal` {#safeds.data.tabular.containers.Column.isTemporal data-toc-label='[attribute] isTemporal'} Whether the column is temporal. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `name` {#safeds.data.tabular.containers.Column.name data-toc-label='[attr] name'} +## `name` {#safeds.data.tabular.containers.Column.name data-toc-label='[attribute] name'} The name of the column. **Type:** [`String`][safeds.lang.String] -## `#!sds attr` `plot` {#safeds.data.tabular.containers.Column.plot data-toc-label='[attr] plot'} +## `plot` {#safeds.data.tabular.containers.Column.plot data-toc-label='[attribute] plot'} The plotter for the column. **Type:** [`ColumnPlotter`][safeds.data.tabular.plotting.ColumnPlotter] -## `#!sds attr` `rowCount` {#safeds.data.tabular.containers.Column.rowCount data-toc-label='[attr] rowCount'} +## `rowCount` {#safeds.data.tabular.containers.Column.rowCount data-toc-label='[attribute] rowCount'} The number of rows in the column. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `type` {#safeds.data.tabular.containers.Column.type data-toc-label='[attr] type'} +## `type` {#safeds.data.tabular.containers.Column.type data-toc-label='[attribute] type'} The type of the column. **Type:** [`DataType`][safeds.data.tabular.typing.DataType] -## `#!sds fun` `correlationWith` {#safeds.data.tabular.containers.Column.correlationWith data-toc-label='[fun] correlationWith'} +## `correlationWith` {#safeds.data.tabular.containers.Column.correlationWith data-toc-label='[function] correlationWith'} Calculate the Pearson correlation between this column and another column. @@ -484,7 +484,7 @@ pipeline example { ) -> correlation: Float ``` -## `#!sds fun` `distinctValueCount` {#safeds.data.tabular.containers.Column.distinctValueCount data-toc-label='[fun] distinctValueCount'} +## `distinctValueCount` {#safeds.data.tabular.containers.Column.distinctValueCount data-toc-label='[function] distinctValueCount'} Return the number of distinct values in the column. @@ -519,7 +519,7 @@ pipeline example { ) -> distinctValueCount: Int ``` -## `#!sds fun` `getValue` {#safeds.data.tabular.containers.Column.getValue data-toc-label='[fun] getValue'} +## `getValue` {#safeds.data.tabular.containers.Column.getValue data-toc-label='[function] getValue'} Return the column value at specified index. @@ -557,7 +557,7 @@ pipeline example { ) -> value: T ``` -## `#!sds fun` `idness` {#safeds.data.tabular.containers.Column.idness data-toc-label='[fun] idness'} +## `idness` {#safeds.data.tabular.containers.Column.idness data-toc-label='[function] idness'} Calculate the idness of this column. @@ -595,7 +595,7 @@ pipeline example { fun idness() -> idness: Float ``` -## `#!sds fun` `max` {#safeds.data.tabular.containers.Column.max data-toc-label='[fun] max'} +## `max` {#safeds.data.tabular.containers.Column.max data-toc-label='[function] max'} Return the maximum value in the column. @@ -621,7 +621,7 @@ pipeline example { fun max() -> max: T? ``` -## `#!sds fun` `mean` {#safeds.data.tabular.containers.Column.mean data-toc-label='[fun] mean'} +## `mean` {#safeds.data.tabular.containers.Column.mean data-toc-label='[function] mean'} Return the mean of the values in the column. @@ -649,7 +649,7 @@ pipeline example { fun mean() -> mean: T ``` -## `#!sds fun` `median` {#safeds.data.tabular.containers.Column.median data-toc-label='[fun] median'} +## `median` {#safeds.data.tabular.containers.Column.median data-toc-label='[function] median'} Return the median of the values in the column. @@ -678,7 +678,7 @@ pipeline example { fun median() -> median: T ``` -## `#!sds fun` `min` {#safeds.data.tabular.containers.Column.min data-toc-label='[fun] min'} +## `min` {#safeds.data.tabular.containers.Column.min data-toc-label='[function] min'} Return the minimum value in the column. @@ -704,7 +704,7 @@ pipeline example { fun min() -> min: T? ``` -## `#!sds fun` `missingValueCount` {#safeds.data.tabular.containers.Column.missingValueCount data-toc-label='[fun] missingValueCount'} +## `missingValueCount` {#safeds.data.tabular.containers.Column.missingValueCount data-toc-label='[function] missingValueCount'} Return the number of missing values in the column. @@ -731,7 +731,7 @@ pipeline example { fun missingValueCount() -> missingValueCount: Int ``` -## `#!sds fun` `missingValueRatio` {#safeds.data.tabular.containers.Column.missingValueRatio data-toc-label='[fun] missingValueRatio'} +## `missingValueRatio` {#safeds.data.tabular.containers.Column.missingValueRatio data-toc-label='[function] missingValueRatio'} Return the missing value ratio. @@ -764,7 +764,7 @@ pipeline example { fun missingValueRatio() -> missingValueRatio: Float ``` -## `#!sds fun` `rename` {#safeds.data.tabular.containers.Column.rename data-toc-label='[fun] rename'} +## `rename` {#safeds.data.tabular.containers.Column.rename data-toc-label='[function] rename'} Return a new column with a new name. @@ -801,7 +801,7 @@ pipeline example { ) -> renamedColumn: Column ``` -## `#!sds fun` `stability` {#safeds.data.tabular.containers.Column.stability data-toc-label='[fun] stability'} +## `stability` {#safeds.data.tabular.containers.Column.stability data-toc-label='[function] stability'} Return the stability of the column. @@ -833,7 +833,7 @@ pipeline example { fun stability() -> stability: Float ``` -## `#!sds fun` `standardDeviation` {#safeds.data.tabular.containers.Column.standardDeviation data-toc-label='[fun] standardDeviation'} +## `standardDeviation` {#safeds.data.tabular.containers.Column.standardDeviation data-toc-label='[function] standardDeviation'} Return the standard deviation of the values in the column. @@ -862,7 +862,7 @@ pipeline example { fun standardDeviation() -> standardDeviation: Float ``` -## `#!sds fun` `summarizeStatistics` {#safeds.data.tabular.containers.Column.summarizeStatistics data-toc-label='[fun] summarizeStatistics'} +## `summarizeStatistics` {#safeds.data.tabular.containers.Column.summarizeStatistics data-toc-label='[function] summarizeStatistics'} Return a table with important statistics about the column. @@ -889,7 +889,7 @@ pipeline example { fun summarizeStatistics() -> statistics: Table ``` -## `#!sds fun` `toList` {#safeds.data.tabular.containers.Column.toList data-toc-label='[fun] toList'} +## `toList` {#safeds.data.tabular.containers.Column.toList data-toc-label='[function] toList'} Return the values of the column in a list. @@ -916,7 +916,7 @@ pipeline example { fun toList() -> values: List ``` -## `#!sds fun` `toTable` {#safeds.data.tabular.containers.Column.toTable data-toc-label='[fun] toTable'} +## `toTable` {#safeds.data.tabular.containers.Column.toTable data-toc-label='[function] toTable'} Create a table that contains only this column. @@ -944,7 +944,7 @@ pipeline example { fun toTable() -> table: Table ``` -## `#!sds fun` `transform` {#safeds.data.tabular.containers.Column.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.containers.Column.transform data-toc-label='[function] transform'} Return a new column with values transformed by the transformer. @@ -987,7 +987,7 @@ pipeline example { ) -> transformedColumn: Column ``` -## `#!sds fun` `variance` {#safeds.data.tabular.containers.Column.variance data-toc-label='[fun] variance'} +## `variance` {#safeds.data.tabular.containers.Column.variance data-toc-label='[function] variance'} Return the variance of the values in the column. diff --git a/docs/api/safeds/data/tabular/containers/Row.md b/docs/api/safeds/data/tabular/containers/Row.md index 12d4facf4..33997bd3d 100644 --- a/docs/api/safeds/data/tabular/containers/Row.md +++ b/docs/api/safeds/data/tabular/containers/Row.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Row` {#safeds.data.tabular.containers.Row data-toc-label='[abstract class] Row'} +# `Row` {#safeds.data.tabular.containers.Row data-toc-label='[class] Row'} A one-dimensional collection of named, heterogeneous values. @@ -67,25 +67,25 @@ This class cannot be instantiated directly. It is only used for arguments of cal } ``` -## `#!sds attr` `columnCount` {#safeds.data.tabular.containers.Row.columnCount data-toc-label='[attr] columnCount'} +## `columnCount` {#safeds.data.tabular.containers.Row.columnCount data-toc-label='[attribute] columnCount'} The number of columns in the row. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `columnNames` {#safeds.data.tabular.containers.Row.columnNames data-toc-label='[attr] columnNames'} +## `columnNames` {#safeds.data.tabular.containers.Row.columnNames data-toc-label='[attribute] columnNames'} The names of the columns in the row. **Type:** [`List`][safeds.lang.List] -## `#!sds attr` `schema` {#safeds.data.tabular.containers.Row.schema data-toc-label='[attr] schema'} +## `schema` {#safeds.data.tabular.containers.Row.schema data-toc-label='[attribute] schema'} The schema of the row. **Type:** [`Schema`][safeds.data.tabular.typing.Schema] -## `#!sds fun` `getColumnType` {#safeds.data.tabular.containers.Row.getColumnType data-toc-label='[fun] getColumnType'} +## `getColumnType` {#safeds.data.tabular.containers.Row.getColumnType data-toc-label='[function] getColumnType'} Get the type of the specified column. @@ -111,7 +111,7 @@ Get the type of the specified column. ) -> type: DataType ``` -## `#!sds fun` `getValue` {#safeds.data.tabular.containers.Row.getValue data-toc-label='[fun] getValue'} +## `getValue` {#safeds.data.tabular.containers.Row.getValue data-toc-label='[function] getValue'} Get the value of the specified column. @@ -137,7 +137,7 @@ Get the value of the specified column. ) -> value: Cell ``` -## `#!sds fun` `hasColumn` {#safeds.data.tabular.containers.Row.hasColumn data-toc-label='[fun] hasColumn'} +## `hasColumn` {#safeds.data.tabular.containers.Row.hasColumn data-toc-label='[function] hasColumn'} Check if the row has a column with the specified name. diff --git a/docs/api/safeds/data/tabular/containers/Table.md b/docs/api/safeds/data/tabular/containers/Table.md index 561480a24..2173e2962 100644 --- a/docs/api/safeds/data/tabular/containers/Table.md +++ b/docs/api/safeds/data/tabular/containers/Table.md @@ -1,4 +1,4 @@ -# `#!sds class` `Table` {#safeds.data.tabular.containers.Table data-toc-label='[class] Table'} +# `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. @@ -962,25 +962,25 @@ pipeline example { } ``` -## `#!sds attr` `columnCount` {#safeds.data.tabular.containers.Table.columnCount data-toc-label='[attr] columnCount'} +## `columnCount` {#safeds.data.tabular.containers.Table.columnCount data-toc-label='[attribute] columnCount'} The number of columns in the table. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `columnNames` {#safeds.data.tabular.containers.Table.columnNames data-toc-label='[attr] columnNames'} +## `columnNames` {#safeds.data.tabular.containers.Table.columnNames data-toc-label='[attribute] columnNames'} The names of the columns in the table. **Type:** [`List`][safeds.lang.List] -## `#!sds attr` `plot` {#safeds.data.tabular.containers.Table.plot data-toc-label='[attr] plot'} +## `plot` {#safeds.data.tabular.containers.Table.plot data-toc-label='[attribute] plot'} The plotter for the table. **Type:** [`TablePlotter`][safeds.data.tabular.plotting.TablePlotter] -## `#!sds attr` `rowCount` {#safeds.data.tabular.containers.Table.rowCount data-toc-label='[attr] rowCount'} +## `rowCount` {#safeds.data.tabular.containers.Table.rowCount data-toc-label='[attribute] rowCount'} The number of rows in the table. @@ -988,13 +988,13 @@ The number of rows in the table. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `schema` {#safeds.data.tabular.containers.Table.schema data-toc-label='[attr] schema'} +## `schema` {#safeds.data.tabular.containers.Table.schema data-toc-label='[attribute] schema'} The schema of the table. **Type:** [`Schema`][safeds.data.tabular.typing.Schema] -## `#!sds fun` `addColumns` {#safeds.data.tabular.containers.Table.addColumns data-toc-label='[fun] addColumns'} +## `addColumns` {#safeds.data.tabular.containers.Table.addColumns data-toc-label='[function] addColumns'} Return a new table with additional columns. @@ -1035,7 +1035,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `addComputedColumn` {#safeds.data.tabular.containers.Table.addComputedColumn data-toc-label='[fun] addComputedColumn'} +## `addComputedColumn` {#safeds.data.tabular.containers.Table.addComputedColumn data-toc-label='[function] addComputedColumn'} Return a new table with an additional computed column. @@ -1074,7 +1074,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `addTableAsColumns` {#safeds.data.tabular.containers.Table.addTableAsColumns data-toc-label='[fun] addTableAsColumns'} +## `addTableAsColumns` {#safeds.data.tabular.containers.Table.addTableAsColumns data-toc-label='[function] addTableAsColumns'} Return a new table with the columns of another table added. @@ -1116,7 +1116,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `addTableAsRows` {#safeds.data.tabular.containers.Table.addTableAsRows data-toc-label='[fun] addTableAsRows'} +## `addTableAsRows` {#safeds.data.tabular.containers.Table.addTableAsRows data-toc-label='[function] addTableAsRows'} Return a new table with the rows of another table added. @@ -1158,7 +1158,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `getColumn` {#safeds.data.tabular.containers.Table.getColumn data-toc-label='[fun] getColumn'} +## `getColumn` {#safeds.data.tabular.containers.Table.getColumn data-toc-label='[function] getColumn'} Get a column from the table. @@ -1196,7 +1196,7 @@ pipeline example { ) -> column: Column ``` -## `#!sds fun` `getColumnType` {#safeds.data.tabular.containers.Table.getColumnType data-toc-label='[fun] getColumnType'} +## `getColumnType` {#safeds.data.tabular.containers.Table.getColumnType data-toc-label='[function] getColumnType'} Get the data type of a column. @@ -1231,7 +1231,7 @@ pipeline example { ) -> type: DataType ``` -## `#!sds fun` `hasColumn` {#safeds.data.tabular.containers.Table.hasColumn data-toc-label='[fun] hasColumn'} +## `hasColumn` {#safeds.data.tabular.containers.Table.hasColumn data-toc-label='[function] hasColumn'} Check if the table has a column with a specific name. @@ -1266,7 +1266,7 @@ pipeline example { ) -> hasColumn: Boolean ``` -## `#!sds fun` `inverseTransformTable` {#safeds.data.tabular.containers.Table.inverseTransformTable data-toc-label='[fun] inverseTransformTable'} +## `inverseTransformTable` {#safeds.data.tabular.containers.Table.inverseTransformTable data-toc-label='[function] inverseTransformTable'} Return a new table inverse-transformed by a **fitted, invertible** transformer. @@ -1308,7 +1308,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `removeColumns` {#safeds.data.tabular.containers.Table.removeColumns data-toc-label='[fun] removeColumns'} +## `removeColumns` {#safeds.data.tabular.containers.Table.removeColumns data-toc-label='[function] removeColumns'} Return a new table without the specified columns. @@ -1357,7 +1357,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `removeColumnsExcept` {#safeds.data.tabular.containers.Table.removeColumnsExcept data-toc-label='[fun] removeColumnsExcept'} +## `removeColumnsExcept` {#safeds.data.tabular.containers.Table.removeColumnsExcept data-toc-label='[function] removeColumnsExcept'} Return a new table with only the specified columns. @@ -1393,7 +1393,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `removeColumnsWithMissingValues` {#safeds.data.tabular.containers.Table.removeColumnsWithMissingValues data-toc-label='[fun] removeColumnsWithMissingValues'} +## `removeColumnsWithMissingValues` {#safeds.data.tabular.containers.Table.removeColumnsWithMissingValues data-toc-label='[function] removeColumnsWithMissingValues'} Return a new table without columns that contain missing values. @@ -1426,7 +1426,7 @@ pipeline example { fun removeColumnsWithMissingValues() -> newTable: Table ``` -## `#!sds fun` `removeDuplicateRows` {#safeds.data.tabular.containers.Table.removeDuplicateRows data-toc-label='[fun] removeDuplicateRows'} +## `removeDuplicateRows` {#safeds.data.tabular.containers.Table.removeDuplicateRows data-toc-label='[function] removeDuplicateRows'} Return a new table without duplicate rows. @@ -1456,7 +1456,7 @@ pipeline example { fun removeDuplicateRows() -> newTable: Table ``` -## `#!sds fun` `removeNonNumericColumns` {#safeds.data.tabular.containers.Table.removeNonNumericColumns data-toc-label='[fun] removeNonNumericColumns'} +## `removeNonNumericColumns` {#safeds.data.tabular.containers.Table.removeNonNumericColumns data-toc-label='[function] removeNonNumericColumns'} Return a new table without non-numeric columns. @@ -1486,7 +1486,7 @@ pipeline example { fun removeNonNumericColumns() -> newTable: Table ``` -## `#!sds fun` `removeRows` {#safeds.data.tabular.containers.Table.removeRows data-toc-label='[fun] removeRows'} +## `removeRows` {#safeds.data.tabular.containers.Table.removeRows data-toc-label='[function] removeRows'} Return a new table without rows that satisfy a condition. @@ -1524,7 +1524,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `removeRowsByColumn` {#safeds.data.tabular.containers.Table.removeRowsByColumn data-toc-label='[fun] removeRowsByColumn'} +## `removeRowsByColumn` {#safeds.data.tabular.containers.Table.removeRowsByColumn data-toc-label='[function] removeRowsByColumn'} Return a new table without rows that satisfy a condition on a specific column. @@ -1564,7 +1564,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `removeRowsWithMissingValues` {#safeds.data.tabular.containers.Table.removeRowsWithMissingValues data-toc-label='[fun] removeRowsWithMissingValues'} +## `removeRowsWithMissingValues` {#safeds.data.tabular.containers.Table.removeRowsWithMissingValues data-toc-label='[function] removeRowsWithMissingValues'} Return a new table without rows containing missing values in the specified columns. @@ -1602,7 +1602,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `removeRowsWithOutliers` {#safeds.data.tabular.containers.Table.removeRowsWithOutliers data-toc-label='[fun] removeRowsWithOutliers'} +## `removeRowsWithOutliers` {#safeds.data.tabular.containers.Table.removeRowsWithOutliers data-toc-label='[function] removeRowsWithOutliers'} Return a new table without rows containing outliers in the specified columns. @@ -1658,7 +1658,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `renameColumn` {#safeds.data.tabular.containers.Table.renameColumn data-toc-label='[fun] renameColumn'} +## `renameColumn` {#safeds.data.tabular.containers.Table.renameColumn data-toc-label='[function] renameColumn'} Return a new table with a column renamed. @@ -1698,7 +1698,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `replaceColumn` {#safeds.data.tabular.containers.Table.replaceColumn data-toc-label='[fun] replaceColumn'} +## `replaceColumn` {#safeds.data.tabular.containers.Table.replaceColumn data-toc-label='[function] replaceColumn'} Return a new table with a column replaced by zero or more columns. @@ -1738,7 +1738,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `shuffleRows` {#safeds.data.tabular.containers.Table.shuffleRows data-toc-label='[fun] shuffleRows'} +## `shuffleRows` {#safeds.data.tabular.containers.Table.shuffleRows data-toc-label='[function] shuffleRows'} Return a new table with the rows shuffled. @@ -1768,7 +1768,7 @@ pipeline example { fun shuffleRows() -> newTable: Table ``` -## `#!sds fun` `sliceRows` {#safeds.data.tabular.containers.Table.sliceRows data-toc-label='[fun] sliceRows'} +## `sliceRows` {#safeds.data.tabular.containers.Table.sliceRows data-toc-label='[function] sliceRows'} Return a new table with a slice of rows. @@ -1815,7 +1815,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `sortRows` {#safeds.data.tabular.containers.Table.sortRows data-toc-label='[fun] sortRows'} +## `sortRows` {#safeds.data.tabular.containers.Table.sortRows data-toc-label='[function] sortRows'} Return a new table with the rows sorted. @@ -1855,7 +1855,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `sortRowsByColumn` {#safeds.data.tabular.containers.Table.sortRowsByColumn data-toc-label='[fun] sortRowsByColumn'} +## `sortRowsByColumn` {#safeds.data.tabular.containers.Table.sortRowsByColumn data-toc-label='[function] sortRowsByColumn'} Return a new table with the rows sorted by a specific column. @@ -1895,7 +1895,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `splitRows` {#safeds.data.tabular.containers.Table.splitRows data-toc-label='[fun] splitRows'} +## `splitRows` {#safeds.data.tabular.containers.Table.splitRows data-toc-label='[function] splitRows'} Create two tables by splitting the rows of the current table. @@ -1941,7 +1941,7 @@ pipeline example { ) -> (firstTable: Table, secondTable: Table) ``` -## `#!sds fun` `summarizeStatistics` {#safeds.data.tabular.containers.Table.summarizeStatistics data-toc-label='[fun] summarizeStatistics'} +## `summarizeStatistics` {#safeds.data.tabular.containers.Table.summarizeStatistics data-toc-label='[function] summarizeStatistics'} Return a table with important statistics about this table. @@ -1968,7 +1968,7 @@ pipeline example { fun summarizeStatistics() -> statistics: Table ``` -## `#!sds fun` `toColumns` {#safeds.data.tabular.containers.Table.toColumns data-toc-label='[fun] toColumns'} +## `toColumns` {#safeds.data.tabular.containers.Table.toColumns data-toc-label='[function] toColumns'} Return the data of the table as a list of columns. @@ -1995,7 +1995,7 @@ pipeline example { fun toColumns() -> columns: List ``` -## `#!sds fun` `toCsvFile` {#safeds.data.tabular.containers.Table.toCsvFile data-toc-label='[fun] toCsvFile'} +## `toCsvFile` {#safeds.data.tabular.containers.Table.toCsvFile data-toc-label='[function] toCsvFile'} Write the table to a CSV file. @@ -2027,7 +2027,7 @@ pipeline example { ) ``` -## `#!sds fun` `toJsonFile` {#safeds.data.tabular.containers.Table.toJsonFile data-toc-label='[fun] toJsonFile'} +## `toJsonFile` {#safeds.data.tabular.containers.Table.toJsonFile data-toc-label='[function] toJsonFile'} Write the table to a JSON file. @@ -2063,7 +2063,7 @@ pipeline example { ) ``` -## `#!sds fun` `toMap` {#safeds.data.tabular.containers.Table.toMap data-toc-label='[fun] toMap'} +## `toMap` {#safeds.data.tabular.containers.Table.toMap data-toc-label='[function] toMap'} Return a map that maps column names to column values. @@ -2091,7 +2091,7 @@ pipeline example { fun toMap() -> map: Map> ``` -## `#!sds fun` `toParquetFile` {#safeds.data.tabular.containers.Table.toParquetFile data-toc-label='[fun] toParquetFile'} +## `toParquetFile` {#safeds.data.tabular.containers.Table.toParquetFile data-toc-label='[function] toParquetFile'} Write the table to a Parquet file. @@ -2123,7 +2123,7 @@ pipeline example { ) ``` -## `#!sds fun` `toTabularDataset` {#safeds.data.tabular.containers.Table.toTabularDataset data-toc-label='[fun] toTabularDataset'} +## `toTabularDataset` {#safeds.data.tabular.containers.Table.toTabularDataset data-toc-label='[function] toTabularDataset'} Return a new `TabularDataset` with columns marked as a target, feature, or extra. @@ -2174,7 +2174,7 @@ pipeline example { ) -> dataset: TabularDataset ``` -## `#!sds fun` `toTimeSeriesDataset` {#safeds.data.tabular.containers.Table.toTimeSeriesDataset data-toc-label='[fun] toTimeSeriesDataset'} +## `toTimeSeriesDataset` {#safeds.data.tabular.containers.Table.toTimeSeriesDataset data-toc-label='[function] toTimeSeriesDataset'} Return a new `TimeSeriesDataset` with columns marked as a target column, time or feature columns. @@ -2221,7 +2221,7 @@ pipeline example { ) -> dataset: TimeSeriesDataset ``` -## `#!sds fun` `transformColumn` {#safeds.data.tabular.containers.Table.transformColumn data-toc-label='[fun] transformColumn'} +## `transformColumn` {#safeds.data.tabular.containers.Table.transformColumn data-toc-label='[function] transformColumn'} Return a new table with a column transformed. @@ -2261,7 +2261,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds fun` `transformTable` {#safeds.data.tabular.containers.Table.transformTable data-toc-label='[fun] transformTable'} +## `transformTable` {#safeds.data.tabular.containers.Table.transformTable data-toc-label='[function] transformTable'} Return a new table transformed by a **fitted** transformer. @@ -2303,7 +2303,7 @@ pipeline example { ) -> newTable: Table ``` -## `#!sds static fun` `fromColumns` {#safeds.data.tabular.containers.Table.fromColumns data-toc-label='[static fun] fromColumns'} +## `fromColumns` {#safeds.data.tabular.containers.Table.fromColumns data-toc-label='[static-function] fromColumns'} Create a table from a list of columns. @@ -2339,7 +2339,7 @@ pipeline example { ) -> table: Table ``` -## `#!sds static fun` `fromCsvFile` {#safeds.data.tabular.containers.Table.fromCsvFile data-toc-label='[static fun] fromCsvFile'} +## `fromCsvFile` {#safeds.data.tabular.containers.Table.fromCsvFile data-toc-label='[static-function] fromCsvFile'} Create a table from a CSV file. @@ -2375,7 +2375,7 @@ pipeline example { ) -> table: Table ``` -## `#!sds static fun` `fromJsonFile` {#safeds.data.tabular.containers.Table.fromJsonFile data-toc-label='[static fun] fromJsonFile'} +## `fromJsonFile` {#safeds.data.tabular.containers.Table.fromJsonFile data-toc-label='[static-function] fromJsonFile'} Create a table from a JSON file. @@ -2409,7 +2409,7 @@ pipeline example { ) -> table: Table ``` -## `#!sds static fun` `fromMap` {#safeds.data.tabular.containers.Table.fromMap data-toc-label='[static fun] fromMap'} +## `fromMap` {#safeds.data.tabular.containers.Table.fromMap data-toc-label='[static-function] fromMap'} Create a table from a map that maps column names to column values. @@ -2444,7 +2444,7 @@ pipeline example { ) -> table: Table ``` -## `#!sds static fun` `fromParquetFile` {#safeds.data.tabular.containers.Table.fromParquetFile data-toc-label='[static fun] fromParquetFile'} +## `fromParquetFile` {#safeds.data.tabular.containers.Table.fromParquetFile data-toc-label='[static-function] fromParquetFile'} Create a table from a Parquet file. diff --git a/docs/api/safeds/data/tabular/plotting/ColumnPlotter.md b/docs/api/safeds/data/tabular/plotting/ColumnPlotter.md index ab292e7d3..3b8d6a9b0 100644 --- a/docs/api/safeds/data/tabular/plotting/ColumnPlotter.md +++ b/docs/api/safeds/data/tabular/plotting/ColumnPlotter.md @@ -1,4 +1,4 @@ -# `#!sds class` `ColumnPlotter` {#safeds.data.tabular.plotting.ColumnPlotter data-toc-label='[class] ColumnPlotter'} +# `ColumnPlotter` {#safeds.data.tabular.plotting.ColumnPlotter data-toc-label='[class] ColumnPlotter'} A class that contains plotting methods for a column. @@ -79,7 +79,7 @@ pipeline example { } ``` -## `#!sds fun` `boxPlot` {#safeds.data.tabular.plotting.ColumnPlotter.boxPlot data-toc-label='[fun] boxPlot'} +## `boxPlot` {#safeds.data.tabular.plotting.ColumnPlotter.boxPlot data-toc-label='[function] boxPlot'} Create a box plot for the values in the column. This is only possible for numeric columns. @@ -106,7 +106,7 @@ pipeline example { fun boxPlot() -> plot: Image ``` -## `#!sds fun` `histogram` {#safeds.data.tabular.plotting.ColumnPlotter.histogram data-toc-label='[fun] histogram'} +## `histogram` {#safeds.data.tabular.plotting.ColumnPlotter.histogram data-toc-label='[function] histogram'} Create a histogram for the values in the column. @@ -142,7 +142,7 @@ pipeline example { } ``` -## `#!sds fun` `lagPlot` {#safeds.data.tabular.plotting.ColumnPlotter.lagPlot data-toc-label='[fun] lagPlot'} +## `lagPlot` {#safeds.data.tabular.plotting.ColumnPlotter.lagPlot data-toc-label='[function] lagPlot'} Create a lag plot for the values in the column. diff --git a/docs/api/safeds/data/tabular/plotting/TablePlotter.md b/docs/api/safeds/data/tabular/plotting/TablePlotter.md index 32a975065..b72662e99 100644 --- a/docs/api/safeds/data/tabular/plotting/TablePlotter.md +++ b/docs/api/safeds/data/tabular/plotting/TablePlotter.md @@ -1,4 +1,4 @@ -# `#!sds class` `TablePlotter` {#safeds.data.tabular.plotting.TablePlotter data-toc-label='[class] TablePlotter'} +# `TablePlotter` {#safeds.data.tabular.plotting.TablePlotter data-toc-label='[class] TablePlotter'} A class that contains plotting methods for a table. @@ -127,7 +127,7 @@ pipeline example { } ``` -## `#!sds fun` `boxPlots` {#safeds.data.tabular.plotting.TablePlotter.boxPlots data-toc-label='[fun] boxPlots'} +## `boxPlots` {#safeds.data.tabular.plotting.TablePlotter.boxPlots data-toc-label='[function] boxPlots'} Plot a boxplot for every numerical column. @@ -154,7 +154,7 @@ pipeline example { fun boxPlots() -> plot: Image ``` -## `#!sds fun` `correlationHeatmap` {#safeds.data.tabular.plotting.TablePlotter.correlationHeatmap data-toc-label='[fun] correlationHeatmap'} +## `correlationHeatmap` {#safeds.data.tabular.plotting.TablePlotter.correlationHeatmap data-toc-label='[function] correlationHeatmap'} Plot a correlation heatmap for all numerical columns of this `Table`. @@ -181,7 +181,7 @@ pipeline example { fun correlationHeatmap() -> plot: Image ``` -## `#!sds fun` `histograms` {#safeds.data.tabular.plotting.TablePlotter.histograms data-toc-label='[fun] histograms'} +## `histograms` {#safeds.data.tabular.plotting.TablePlotter.histograms data-toc-label='[function] histograms'} Plot a histogram for every column. @@ -217,7 +217,7 @@ pipeline example { } ``` -## `#!sds fun` `linePlot` {#safeds.data.tabular.plotting.TablePlotter.linePlot data-toc-label='[fun] linePlot'} +## `linePlot` {#safeds.data.tabular.plotting.TablePlotter.linePlot data-toc-label='[function] linePlot'} Create a line plot for two columns in the table. @@ -259,7 +259,7 @@ pipeline example { ) -> plot: Image ``` -## `#!sds fun` `scatterPlot` {#safeds.data.tabular.plotting.TablePlotter.scatterPlot data-toc-label='[fun] scatterPlot'} +## `scatterPlot` {#safeds.data.tabular.plotting.TablePlotter.scatterPlot data-toc-label='[function] scatterPlot'} Create a scatter plot for two columns in the table. diff --git a/docs/api/safeds/data/tabular/transformation/Discretizer.md b/docs/api/safeds/data/tabular/transformation/Discretizer.md index 38024a905..f1cd9005c 100644 --- a/docs/api/safeds/data/tabular/transformation/Discretizer.md +++ b/docs/api/safeds/data/tabular/transformation/Discretizer.md @@ -1,4 +1,4 @@ -# `#!sds class` `Discretizer` {#safeds.data.tabular.transformation.Discretizer data-toc-label='[class] Discretizer'} +# `Discretizer` {#safeds.data.tabular.transformation.Discretizer data-toc-label='[class] Discretizer'} The Discretizer bins continuous data into intervals. @@ -70,19 +70,19 @@ pipeline example { } ``` -## `#!sds attr` `binCount` {#safeds.data.tabular.transformation.Discretizer.binCount data-toc-label='[attr] binCount'} +## `binCount` {#safeds.data.tabular.transformation.Discretizer.binCount data-toc-label='[attribute] binCount'} The number of bins to be created. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.Discretizer.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.Discretizer.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.Discretizer.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.Discretizer.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -111,7 +111,7 @@ This transformer is not modified. ) -> fittedTransformer: Discretizer ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.Discretizer.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.Discretizer.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -142,7 +142,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: Discretizer, transformedTable: Table) ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.Discretizer.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.Discretizer.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/transformation/InvertibleTableTransformer.md b/docs/api/safeds/data/tabular/transformation/InvertibleTableTransformer.md index 1a27c53a1..1c0c8420c 100644 --- a/docs/api/safeds/data/tabular/transformation/InvertibleTableTransformer.md +++ b/docs/api/safeds/data/tabular/transformation/InvertibleTableTransformer.md @@ -1,4 +1,4 @@ -# `#!sds class` `InvertibleTableTransformer` {#safeds.data.tabular.transformation.InvertibleTableTransformer data-toc-label='[class] InvertibleTableTransformer'} +# `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. @@ -68,13 +68,13 @@ A `TableTransformer` that can also undo the learned transformation after it has } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.InvertibleTableTransformer.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.InvertibleTableTransformer.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.InvertibleTableTransformer.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.InvertibleTableTransformer.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -103,7 +103,7 @@ Learn a transformation for a set of columns in a table. ) -> fittedTransformer: InvertibleTableTransformer ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.InvertibleTableTransformer.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.InvertibleTableTransformer.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -134,7 +134,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: InvertibleTableTransformer, transformedTable: Table) ``` -## `#!sds fun` `inverseTransform` {#safeds.data.tabular.transformation.InvertibleTableTransformer.inverseTransform data-toc-label='[fun] inverseTransform'} +## `inverseTransform` {#safeds.data.tabular.transformation.InvertibleTableTransformer.inverseTransform data-toc-label='[function] inverseTransform'} Undo the learned transformation as well as possible. @@ -164,7 +164,7 @@ Column order and types may differ from the original table. Likewise, some values ) -> originalTable: Table ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.InvertibleTableTransformer.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.InvertibleTableTransformer.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/transformation/LabelEncoder.md b/docs/api/safeds/data/tabular/transformation/LabelEncoder.md index 314879bdd..ac75b8f18 100644 --- a/docs/api/safeds/data/tabular/transformation/LabelEncoder.md +++ b/docs/api/safeds/data/tabular/transformation/LabelEncoder.md @@ -1,4 +1,4 @@ -# `#!sds class` `LabelEncoder` {#safeds.data.tabular.transformation.LabelEncoder data-toc-label='[class] LabelEncoder'} +# `LabelEncoder` {#safeds.data.tabular.transformation.LabelEncoder data-toc-label='[class] LabelEncoder'} The LabelEncoder encodes one or more given columns into labels. @@ -65,13 +65,13 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.LabelEncoder.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.LabelEncoder.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.LabelEncoder.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.LabelEncoder.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -100,7 +100,7 @@ This transformer is not modified. ) -> fittedTransformer: LabelEncoder ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.LabelEncoder.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.LabelEncoder.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -131,7 +131,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: LabelEncoder, transformedTable: Table) ``` -## `#!sds fun` `inverseTransform` {#safeds.data.tabular.transformation.LabelEncoder.inverseTransform data-toc-label='[fun] inverseTransform'} +## `inverseTransform` {#safeds.data.tabular.transformation.LabelEncoder.inverseTransform data-toc-label='[function] inverseTransform'} Undo the learned transformation as well as possible. @@ -161,7 +161,7 @@ Column order and types may differ from the original table. Likewise, some values ) -> originalTable: Table ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.LabelEncoder.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.LabelEncoder.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/transformation/OneHotEncoder.md b/docs/api/safeds/data/tabular/transformation/OneHotEncoder.md index 588ed69bb..00024908d 100644 --- a/docs/api/safeds/data/tabular/transformation/OneHotEncoder.md +++ b/docs/api/safeds/data/tabular/transformation/OneHotEncoder.md @@ -1,4 +1,4 @@ -# `#!sds class` `OneHotEncoder` {#safeds.data.tabular.transformation.OneHotEncoder data-toc-label='[class] OneHotEncoder'} +# `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. @@ -88,13 +88,13 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.OneHotEncoder.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.OneHotEncoder.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.OneHotEncoder.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.OneHotEncoder.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -123,7 +123,7 @@ This transformer is not modified. ) -> fittedTransformer: OneHotEncoder ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.OneHotEncoder.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.OneHotEncoder.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -154,7 +154,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: OneHotEncoder, transformedTable: Table) ``` -## `#!sds fun` `inverseTransform` {#safeds.data.tabular.transformation.OneHotEncoder.inverseTransform data-toc-label='[fun] inverseTransform'} +## `inverseTransform` {#safeds.data.tabular.transformation.OneHotEncoder.inverseTransform data-toc-label='[function] inverseTransform'} Undo the learned transformation as well as possible. @@ -184,7 +184,7 @@ Column order and types may differ from the original table. Likewise, some values ) -> originalTable: Table ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.OneHotEncoder.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.OneHotEncoder.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/transformation/RangeScaler.md b/docs/api/safeds/data/tabular/transformation/RangeScaler.md index e2e871017..165ac67ea 100644 --- a/docs/api/safeds/data/tabular/transformation/RangeScaler.md +++ b/docs/api/safeds/data/tabular/transformation/RangeScaler.md @@ -1,4 +1,4 @@ -# `#!sds class` `RangeScaler` {#safeds.data.tabular.transformation.RangeScaler data-toc-label='[class] RangeScaler'} +# `RangeScaler` {#safeds.data.tabular.transformation.RangeScaler data-toc-label='[class] RangeScaler'} The RangeScaler transforms column values by scaling each value to a given range. @@ -76,25 +76,25 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.RangeScaler.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.RangeScaler.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `max` {#safeds.data.tabular.transformation.RangeScaler.max data-toc-label='[attr] max'} +## `max` {#safeds.data.tabular.transformation.RangeScaler.max data-toc-label='[attribute] max'} The maximum of the new range after the transformation. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `min` {#safeds.data.tabular.transformation.RangeScaler.min data-toc-label='[attr] min'} +## `min` {#safeds.data.tabular.transformation.RangeScaler.min data-toc-label='[attribute] min'} The minimum of the new range after the transformation. **Type:** [`Float`][safeds.lang.Float] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.RangeScaler.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.RangeScaler.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -123,7 +123,7 @@ This transformer is not modified. ) -> fittedTransformer: RangeScaler ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.RangeScaler.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.RangeScaler.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -154,7 +154,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: RangeScaler, transformedTable: Table) ``` -## `#!sds fun` `inverseTransform` {#safeds.data.tabular.transformation.RangeScaler.inverseTransform data-toc-label='[fun] inverseTransform'} +## `inverseTransform` {#safeds.data.tabular.transformation.RangeScaler.inverseTransform data-toc-label='[function] inverseTransform'} Undo the learned transformation as well as possible. @@ -184,7 +184,7 @@ Column order and types may differ from the original table. Likewise, some values ) -> originalTable: Table ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.RangeScaler.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.RangeScaler.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/transformation/SimpleImputer.md b/docs/api/safeds/data/tabular/transformation/SimpleImputer.md index 95e6d5055..2037f8e33 100644 --- a/docs/api/safeds/data/tabular/transformation/SimpleImputer.md +++ b/docs/api/safeds/data/tabular/transformation/SimpleImputer.md @@ -1,4 +1,4 @@ -# `#!sds class` `SimpleImputer` {#safeds.data.tabular.transformation.SimpleImputer data-toc-label='[class] SimpleImputer'} +# `SimpleImputer` {#safeds.data.tabular.transformation.SimpleImputer data-toc-label='[class] SimpleImputer'} Replace missing values with the given strategy. @@ -113,25 +113,25 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.SimpleImputer.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.SimpleImputer.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `strategy` {#safeds.data.tabular.transformation.SimpleImputer.strategy data-toc-label='[attr] strategy'} +## `strategy` {#safeds.data.tabular.transformation.SimpleImputer.strategy data-toc-label='[attribute] strategy'} The strategy used to replace missing values. **Type:** [`Strategy`][safeds.data.tabular.transformation.SimpleImputer.Strategy] -## `#!sds attr` `valueToReplace` {#safeds.data.tabular.transformation.SimpleImputer.valueToReplace data-toc-label='[attr] valueToReplace'} +## `valueToReplace` {#safeds.data.tabular.transformation.SimpleImputer.valueToReplace data-toc-label='[attribute] valueToReplace'} The value that should be replaced. **Type:** [`Any`][safeds.lang.Any] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.SimpleImputer.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.SimpleImputer.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -160,7 +160,7 @@ This transformer is not modified. ) -> fittedTransformer: SimpleImputer ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.SimpleImputer.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.SimpleImputer.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -191,7 +191,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: SimpleImputer, transformedTable: Table) ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.SimpleImputer.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.SimpleImputer.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. @@ -218,7 +218,7 @@ Apply the learned transformation to a table. ) -> transformedTable: Table ``` -## `#!sds enum` `Strategy` {#safeds.data.tabular.transformation.SimpleImputer.Strategy data-toc-label='[enum] Strategy'} +## `Strategy` {#safeds.data.tabular.transformation.SimpleImputer.Strategy data-toc-label='[enum] Strategy'} Various strategies to replace missing values. @@ -254,7 +254,7 @@ Various strategies to replace missing values. } ``` -### `Constant` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Constant data-toc-label='Constant'} +### `Constant` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Constant data-toc-label='[variant] Constant'} Replace missing values with the given constant value. @@ -264,14 +264,14 @@ Replace missing values with the given constant value. |------|------|-------------|---------| | `value` | [`Any`][safeds.lang.Any] | The value to replace missing values. | - | -### `Mean` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Mean data-toc-label='Mean'} +### `Mean` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Mean data-toc-label='[variant] Mean'} Replace missing values with the mean of each column. -### `Median` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Median data-toc-label='Median'} +### `Median` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Median data-toc-label='[variant] Median'} Replace missing values with the median of each column. -### `Mode` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Mode data-toc-label='Mode'} +### `Mode` {#safeds.data.tabular.transformation.SimpleImputer.Strategy.Mode data-toc-label='[variant] Mode'} Replace missing values with the mode of each column. diff --git a/docs/api/safeds/data/tabular/transformation/StandardScaler.md b/docs/api/safeds/data/tabular/transformation/StandardScaler.md index acbf40578..4ecd2e82c 100644 --- a/docs/api/safeds/data/tabular/transformation/StandardScaler.md +++ b/docs/api/safeds/data/tabular/transformation/StandardScaler.md @@ -1,4 +1,4 @@ -# `#!sds class` `StandardScaler` {#safeds.data.tabular.transformation.StandardScaler data-toc-label='[class] StandardScaler'} +# `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. @@ -57,13 +57,13 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.StandardScaler.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.StandardScaler.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.StandardScaler.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.StandardScaler.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -92,7 +92,7 @@ This transformer is not modified. ) -> fittedTransformer: StandardScaler ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.StandardScaler.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.StandardScaler.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -123,7 +123,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: StandardScaler, transformedTable: Table) ``` -## `#!sds fun` `inverseTransform` {#safeds.data.tabular.transformation.StandardScaler.inverseTransform data-toc-label='[fun] inverseTransform'} +## `inverseTransform` {#safeds.data.tabular.transformation.StandardScaler.inverseTransform data-toc-label='[function] inverseTransform'} Undo the learned transformation as well as possible. @@ -153,7 +153,7 @@ Column order and types may differ from the original table. Likewise, some values ) -> originalTable: Table ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.StandardScaler.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.StandardScaler.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/transformation/TableTransformer.md b/docs/api/safeds/data/tabular/transformation/TableTransformer.md index d37060028..2522e05ba 100644 --- a/docs/api/safeds/data/tabular/transformation/TableTransformer.md +++ b/docs/api/safeds/data/tabular/transformation/TableTransformer.md @@ -3,14 +3,13 @@ search: boost: 0.5 --- -# `#!sds abstract class` `TableTransformer` {#safeds.data.tabular.transformation.TableTransformer data-toc-label='[abstract class] TableTransformer'} +# `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. **Inheritors:** - [`Discretizer`][safeds.data.tabular.transformation.Discretizer] -- `#!sds Imputer` - [`InvertibleTableTransformer`][safeds.data.tabular.transformation.InvertibleTableTransformer] - [`SimpleImputer`][safeds.data.tabular.transformation.SimpleImputer] @@ -73,13 +72,13 @@ Learn a transformation for a set of columns in a `Table` and transform another ` } ``` -## `#!sds attr` `isFitted` {#safeds.data.tabular.transformation.TableTransformer.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.data.tabular.transformation.TableTransformer.isFitted data-toc-label='[attribute] isFitted'} Whether the transformer is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.data.tabular.transformation.TableTransformer.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.data.tabular.transformation.TableTransformer.fit data-toc-label='[function] fit'} Learn a transformation for a set of columns in a table. @@ -108,7 +107,7 @@ Learn a transformation for a set of columns in a table. ) -> fittedTransformer: TableTransformer ``` -## `#!sds fun` `fitAndTransform` {#safeds.data.tabular.transformation.TableTransformer.fitAndTransform data-toc-label='[fun] fitAndTransform'} +## `fitAndTransform` {#safeds.data.tabular.transformation.TableTransformer.fitAndTransform data-toc-label='[function] fitAndTransform'} Learn a transformation for a set of columns in a table and apply the learned transformation to the same table. @@ -139,7 +138,7 @@ Learn a transformation for a set of columns in a table and apply the learned tra ) -> (fittedTransformer: TableTransformer, transformedTable: Table) ``` -## `#!sds fun` `transform` {#safeds.data.tabular.transformation.TableTransformer.transform data-toc-label='[fun] transform'} +## `transform` {#safeds.data.tabular.transformation.TableTransformer.transform data-toc-label='[function] transform'} Apply the learned transformation to a table. diff --git a/docs/api/safeds/data/tabular/typing/DataType.md b/docs/api/safeds/data/tabular/typing/DataType.md index 135e4dab5..3e4571d65 100644 --- a/docs/api/safeds/data/tabular/typing/DataType.md +++ b/docs/api/safeds/data/tabular/typing/DataType.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `DataType` {#safeds.data.tabular.typing.DataType data-toc-label='[abstract class] DataType'} +# `DataType` {#safeds.data.tabular.typing.DataType data-toc-label='[class] DataType'} The type of a column or cell in a table. @@ -22,13 +22,13 @@ The type of a column or cell in a table. } ``` -## `#!sds attr` `isNumeric` {#safeds.data.tabular.typing.DataType.isNumeric data-toc-label='[attr] isNumeric'} +## `isNumeric` {#safeds.data.tabular.typing.DataType.isNumeric data-toc-label='[attribute] isNumeric'} Whether the column type is numeric. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `isTemporal` {#safeds.data.tabular.typing.DataType.isTemporal data-toc-label='[attr] isTemporal'} +## `isTemporal` {#safeds.data.tabular.typing.DataType.isTemporal data-toc-label='[attribute] isTemporal'} Whether the column type is temporal. diff --git a/docs/api/safeds/data/tabular/typing/Schema.md b/docs/api/safeds/data/tabular/typing/Schema.md index f14442909..c3c7edd2a 100644 --- a/docs/api/safeds/data/tabular/typing/Schema.md +++ b/docs/api/safeds/data/tabular/typing/Schema.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Schema` {#safeds.data.tabular.typing.Schema data-toc-label='[abstract class] Schema'} +# `Schema` {#safeds.data.tabular.typing.Schema data-toc-label='[class] Schema'} The schema of a row or table. @@ -71,13 +71,13 @@ The schema of a row or table. } ``` -## `#!sds attr` `columnNames` {#safeds.data.tabular.typing.Schema.columnNames data-toc-label='[attr] columnNames'} +## `columnNames` {#safeds.data.tabular.typing.Schema.columnNames data-toc-label='[attribute] columnNames'} Return a list of all column names contained in this schema. **Type:** [`List`][safeds.lang.List] -## `#!sds fun` `getColumnType` {#safeds.data.tabular.typing.Schema.getColumnType data-toc-label='[fun] getColumnType'} +## `getColumnType` {#safeds.data.tabular.typing.Schema.getColumnType data-toc-label='[function] getColumnType'} Return the type of the given column. @@ -112,7 +112,7 @@ pipeline example { ) -> type: DataType ``` -## `#!sds fun` `hasColumn` {#safeds.data.tabular.typing.Schema.hasColumn data-toc-label='[fun] hasColumn'} +## `hasColumn` {#safeds.data.tabular.typing.Schema.hasColumn data-toc-label='[function] hasColumn'} Return whether the schema contains a given column. @@ -147,7 +147,7 @@ pipeline example { ) -> contains: Boolean ``` -## `#!sds fun` `toMap` {#safeds.data.tabular.typing.Schema.toMap data-toc-label='[fun] toMap'} +## `toMap` {#safeds.data.tabular.typing.Schema.toMap data-toc-label='[function] toMap'} Return a dictionary that maps column names to column types. diff --git a/docs/api/safeds/lang/AnnotationTarget.md b/docs/api/safeds/lang/AnnotationTarget.md index 69697996d..804f1fbdd 100644 --- a/docs/api/safeds/lang/AnnotationTarget.md +++ b/docs/api/safeds/lang/AnnotationTarget.md @@ -1,4 +1,4 @@ -# `#!sds enum` `AnnotationTarget` {#safeds.lang.AnnotationTarget data-toc-label='[enum] AnnotationTarget'} +# `AnnotationTarget` {#safeds.lang.AnnotationTarget data-toc-label='[enum] AnnotationTarget'} The declaration types that can be targeted by annotations. @@ -74,54 +74,54 @@ The declaration types that can be targeted by annotations. } ``` -## `Annotation` {#safeds.lang.AnnotationTarget.Annotation data-toc-label='Annotation'} +## `Annotation` {#safeds.lang.AnnotationTarget.Annotation data-toc-label='[variant] Annotation'} The annotation can be called on annotations. -## `Attribute` {#safeds.lang.AnnotationTarget.Attribute data-toc-label='Attribute'} +## `Attribute` {#safeds.lang.AnnotationTarget.Attribute data-toc-label='[variant] Attribute'} The annotation can be called on attributes. -## `Class` {#safeds.lang.AnnotationTarget.Class data-toc-label='Class'} +## `Class` {#safeds.lang.AnnotationTarget.Class data-toc-label='[variant] Class'} The annotation can be called on classes. -## `Enum` {#safeds.lang.AnnotationTarget.Enum data-toc-label='Enum'} +## `Enum` {#safeds.lang.AnnotationTarget.Enum data-toc-label='[variant] Enum'} The annotation can be called on enums. -## `EnumVariant` {#safeds.lang.AnnotationTarget.EnumVariant data-toc-label='EnumVariant'} +## `EnumVariant` {#safeds.lang.AnnotationTarget.EnumVariant data-toc-label='[variant] EnumVariant'} The annotation can be called on enum variants. -## `Function` {#safeds.lang.AnnotationTarget.Function data-toc-label='Function'} +## `Function` {#safeds.lang.AnnotationTarget.Function data-toc-label='[variant] Function'} The annotation can be called on functions. -## `Module` {#safeds.lang.AnnotationTarget.Module data-toc-label='Module'} +## `Module` {#safeds.lang.AnnotationTarget.Module data-toc-label='[variant] Module'} The annotation can be called on modules (i.e. files). -## `Parameter` {#safeds.lang.AnnotationTarget.Parameter data-toc-label='Parameter'} +## `Parameter` {#safeds.lang.AnnotationTarget.Parameter data-toc-label='[variant] Parameter'} The annotation can be called on parameters. -## `Pipeline` {#safeds.lang.AnnotationTarget.Pipeline data-toc-label='Pipeline'} +## `Pipeline` {#safeds.lang.AnnotationTarget.Pipeline data-toc-label='[variant] Pipeline'} The annotation can be called on pipelines. -## `Result` {#safeds.lang.AnnotationTarget.Result data-toc-label='Result'} +## `Result` {#safeds.lang.AnnotationTarget.Result data-toc-label='[variant] Result'} The annotation can be called on results. -## `Schema` {#safeds.lang.AnnotationTarget.Schema data-toc-label='Schema'} +## `Schema` {#safeds.lang.AnnotationTarget.Schema data-toc-label='[variant] Schema'} The annotation can be called on schemas. -## `Segment` {#safeds.lang.AnnotationTarget.Segment data-toc-label='Segment'} +## `Segment` {#safeds.lang.AnnotationTarget.Segment data-toc-label='[variant] Segment'} The annotation can be called on segments. -## `TypeParameter` {#safeds.lang.AnnotationTarget.TypeParameter data-toc-label='TypeParameter'} +## `TypeParameter` {#safeds.lang.AnnotationTarget.TypeParameter data-toc-label='[variant] TypeParameter'} The annotation can be called on type parameters. diff --git a/docs/api/safeds/lang/Any.md b/docs/api/safeds/lang/Any.md index 38a26f40e..e64857f32 100644 --- a/docs/api/safeds/lang/Any.md +++ b/docs/api/safeds/lang/Any.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Any` {#safeds.lang.Any data-toc-label='[abstract class] Any'} +# `Any` {#safeds.lang.Any data-toc-label='[class] Any'} The common superclass of all classes. @@ -43,7 +43,7 @@ The common superclass of all classes. } ``` -## `#!sds fun` `toBoolean` {#safeds.lang.Any.toBoolean data-toc-label='[fun] toBoolean'} +## `toBoolean` {#safeds.lang.Any.toBoolean data-toc-label='[function] toBoolean'} Return whether the object is truthy. @@ -74,7 +74,7 @@ pipeline example { fun toBoolean() -> boolean: Boolean ``` -## `#!sds fun` `toString` {#safeds.lang.Any.toString data-toc-label='[fun] toString'} +## `toString` {#safeds.lang.Any.toString data-toc-label='[function] toString'} Return a string representation of the object. diff --git a/docs/api/safeds/lang/Boolean.md b/docs/api/safeds/lang/Boolean.md index ac5d6d6f7..73a46aa81 100644 --- a/docs/api/safeds/lang/Boolean.md +++ b/docs/api/safeds/lang/Boolean.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Boolean` {#safeds.lang.Boolean data-toc-label='[abstract class] Boolean'} +# `Boolean` {#safeds.lang.Boolean data-toc-label='[class] Boolean'} A truth value. diff --git a/docs/api/safeds/lang/Category.md b/docs/api/safeds/lang/Category.md index 4d1036857..b6da53426 100644 --- a/docs/api/safeds/lang/Category.md +++ b/docs/api/safeds/lang/Category.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds annotation` `Category` {#safeds.lang.Category data-toc-label='[annotation] Category'} +# :test_tube:{ title="Experimental" } `Category` {#safeds.lang.Category data-toc-label='[annotation] Category'} The category of a declaration. It can be used for grouping. diff --git a/docs/api/safeds/lang/DataScienceCategory.md b/docs/api/safeds/lang/DataScienceCategory.md index 69c93e71d..c042d6e79 100644 --- a/docs/api/safeds/lang/DataScienceCategory.md +++ b/docs/api/safeds/lang/DataScienceCategory.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds enum` `DataScienceCategory` {#safeds.lang.DataScienceCategory data-toc-label='[enum] DataScienceCategory'} +# :test_tube:{ title="Experimental" } `DataScienceCategory` {#safeds.lang.DataScienceCategory data-toc-label='[enum] DataScienceCategory'} A step in the data science process. @@ -38,26 +38,26 @@ A step in the data science process. } ``` -## `DataExploration` {#safeds.lang.DataScienceCategory.DataExploration data-toc-label='DataExploration'} +## `DataExploration` {#safeds.lang.DataScienceCategory.DataExploration data-toc-label='[variant] DataExploration'} Explore your data. -## `DataExport` {#safeds.lang.DataScienceCategory.DataExport data-toc-label='DataExport'} +## `DataExport` {#safeds.lang.DataScienceCategory.DataExport data-toc-label='[variant] DataExport'} Save your data for later use. -## `DataImport` {#safeds.lang.DataScienceCategory.DataImport data-toc-label='DataImport'} +## `DataImport` {#safeds.lang.DataScienceCategory.DataImport data-toc-label='[variant] DataImport'} Load your data into the program. -## `DataPreparation` {#safeds.lang.DataScienceCategory.DataPreparation data-toc-label='DataPreparation'} +## `DataPreparation` {#safeds.lang.DataScienceCategory.DataPreparation data-toc-label='[variant] DataPreparation'} Prepare your data for analysis. -## `ModelEvaluation` {#safeds.lang.DataScienceCategory.ModelEvaluation data-toc-label='ModelEvaluation'} +## `ModelEvaluation` {#safeds.lang.DataScienceCategory.ModelEvaluation data-toc-label='[variant] ModelEvaluation'} Evaluate the performance of your model. -## `Modeling` {#safeds.lang.DataScienceCategory.Modeling data-toc-label='Modeling'} +## `Modeling` {#safeds.lang.DataScienceCategory.Modeling data-toc-label='[variant] Modeling'} Configure a model and train it on your data. diff --git a/docs/api/safeds/lang/Deprecated.md b/docs/api/safeds/lang/Deprecated.md index cde0d1f79..4fcc4776b 100644 --- a/docs/api/safeds/lang/Deprecated.md +++ b/docs/api/safeds/lang/Deprecated.md @@ -1,4 +1,4 @@ -# `#!sds annotation` `Deprecated` {#safeds.lang.Deprecated data-toc-label='[annotation] Deprecated'} +# `Deprecated` {#safeds.lang.Deprecated data-toc-label='[annotation] Deprecated'} The declaration should no longer be used. diff --git a/docs/api/safeds/lang/Experimental.md b/docs/api/safeds/lang/Experimental.md index 76df3a3b4..1ae8b37cf 100644 --- a/docs/api/safeds/lang/Experimental.md +++ b/docs/api/safeds/lang/Experimental.md @@ -1,4 +1,4 @@ -# `#!sds annotation` `Experimental` {#safeds.lang.Experimental data-toc-label='[annotation] Experimental'} +# `Experimental` {#safeds.lang.Experimental data-toc-label='[annotation] Experimental'} The declaration might change without a major version bump. diff --git a/docs/api/safeds/lang/Expert.md b/docs/api/safeds/lang/Expert.md index 8b318697a..c8ab65535 100644 --- a/docs/api/safeds/lang/Expert.md +++ b/docs/api/safeds/lang/Expert.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds annotation` `Expert` {#safeds.lang.Expert data-toc-label='[annotation] Expert'} +# :test_tube:{ title="Experimental" } `Expert` {#safeds.lang.Expert data-toc-label='[annotation] Expert'} This parameter should only be used by expert users. diff --git a/docs/api/safeds/lang/Float.md b/docs/api/safeds/lang/Float.md index b9aa0c08e..d4ff79a52 100644 --- a/docs/api/safeds/lang/Float.md +++ b/docs/api/safeds/lang/Float.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Float` {#safeds.lang.Float data-toc-label='[abstract class] Float'} +# `Float` {#safeds.lang.Float data-toc-label='[class] Float'} A floating-point number. @@ -36,7 +36,7 @@ pipeline example { } ``` -## `#!sds fun` `toInt` {#safeds.lang.Float.toInt data-toc-label='[fun] toInt'} +## `toInt` {#safeds.lang.Float.toInt data-toc-label='[function] toInt'} Convert this floating-point number to an integer by truncating the fractional part. diff --git a/docs/api/safeds/lang/Impure.md b/docs/api/safeds/lang/Impure.md index d11f15e39..020897c44 100644 --- a/docs/api/safeds/lang/Impure.md +++ b/docs/api/safeds/lang/Impure.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds annotation` `Impure` {#safeds.lang.Impure data-toc-label='[annotation] Impure'} +# :test_tube:{ title="Experimental" } `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. diff --git a/docs/api/safeds/lang/ImpurityReason.md b/docs/api/safeds/lang/ImpurityReason.md index c70044ebb..0e4c57bda 100644 --- a/docs/api/safeds/lang/ImpurityReason.md +++ b/docs/api/safeds/lang/ImpurityReason.md @@ -1,4 +1,4 @@ -# `#!sds enum` `ImpurityReason` {#safeds.lang.ImpurityReason data-toc-label='[enum] ImpurityReason'} +# `ImpurityReason` {#safeds.lang.ImpurityReason data-toc-label='[enum] ImpurityReason'} A reason why a function is impure. @@ -49,7 +49,7 @@ A reason why a function is impure. } ``` -## `FileReadFromConstantPath` {#safeds.lang.ImpurityReason.FileReadFromConstantPath data-toc-label='FileReadFromConstantPath'} +## `FileReadFromConstantPath` {#safeds.lang.ImpurityReason.FileReadFromConstantPath data-toc-label='[variant] FileReadFromConstantPath'} The function reads from a file and the file path is a constant. @@ -59,7 +59,7 @@ The function reads from a file and the file path is a constant. |------|------|-------------|---------| | `path` | [`String`][safeds.lang.String] | The path of the file. | - | -## `FileReadFromParameterizedPath` {#safeds.lang.ImpurityReason.FileReadFromParameterizedPath data-toc-label='FileReadFromParameterizedPath'} +## `FileReadFromParameterizedPath` {#safeds.lang.ImpurityReason.FileReadFromParameterizedPath data-toc-label='[variant] FileReadFromParameterizedPath'} The function reads from a file and the file path is given by a parameter. @@ -69,7 +69,7 @@ The function reads from a file and the file path is given by a parameter. |------|------|-------------|---------| | `parameterName` | [`String`][safeds.lang.String] | The name of the parameter that specifies the file path. | - | -## `FileWriteToConstantPath` {#safeds.lang.ImpurityReason.FileWriteToConstantPath data-toc-label='FileWriteToConstantPath'} +## `FileWriteToConstantPath` {#safeds.lang.ImpurityReason.FileWriteToConstantPath data-toc-label='[variant] FileWriteToConstantPath'} The function writes to a file and the file path is a constant. @@ -79,7 +79,7 @@ The function writes to a file and the file path is a constant. |------|------|-------------|---------| | `path` | [`String`][safeds.lang.String] | The path of the file. | - | -## `FileWriteToParameterizedPath` {#safeds.lang.ImpurityReason.FileWriteToParameterizedPath data-toc-label='FileWriteToParameterizedPath'} +## `FileWriteToParameterizedPath` {#safeds.lang.ImpurityReason.FileWriteToParameterizedPath data-toc-label='[variant] FileWriteToParameterizedPath'} The function writes to a file and the file path is given by a parameter. @@ -89,11 +89,11 @@ The function writes to a file and the file path is given by a parameter. |------|------|-------------|---------| | `parameterName` | [`String`][safeds.lang.String] | The name of the parameter that specifies the file path. | - | -## `Other` {#safeds.lang.ImpurityReason.Other data-toc-label='Other'} +## `Other` {#safeds.lang.ImpurityReason.Other data-toc-label='[variant] Other'} The function is impure for some other reason. If possible, use a more specific reason. -## `PotentiallyImpureParameterCall` {#safeds.lang.ImpurityReason.PotentiallyImpureParameterCall data-toc-label='PotentiallyImpureParameterCall'} +## `PotentiallyImpureParameterCall` {#safeds.lang.ImpurityReason.PotentiallyImpureParameterCall data-toc-label='[variant] PotentiallyImpureParameterCall'} The function calls another, potentially impure function that gets passed as a parameter. diff --git a/docs/api/safeds/lang/Int.md b/docs/api/safeds/lang/Int.md index 7f4d3b336..fbd8cffc3 100644 --- a/docs/api/safeds/lang/Int.md +++ b/docs/api/safeds/lang/Int.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Int` {#safeds.lang.Int data-toc-label='[abstract class] Int'} +# `Int` {#safeds.lang.Int data-toc-label='[class] Int'} An integer. @@ -36,7 +36,7 @@ pipeline example { } ``` -## `#!sds fun` `toFloat` {#safeds.lang.Int.toFloat data-toc-label='[fun] toFloat'} +## `toFloat` {#safeds.lang.Int.toFloat data-toc-label='[function] toFloat'} Convert this integer to a floating-point number. diff --git a/docs/api/safeds/lang/List.md b/docs/api/safeds/lang/List.md index f864262e8..691fef771 100644 --- a/docs/api/safeds/lang/List.md +++ b/docs/api/safeds/lang/List.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `List` {#safeds.lang.List data-toc-label='[abstract class] List'} +# `List` {#safeds.lang.List data-toc-label='[class] List'} A list of elements. @@ -72,7 +72,7 @@ pipeline example { } ``` -## `#!sds fun` `join` {#safeds.lang.List.join data-toc-label='[fun] join'} +## `join` {#safeds.lang.List.join data-toc-label='[function] join'} Join the elements of the list into a string using the separator. @@ -109,7 +109,7 @@ pipeline example { fun join(separator: String = ", ") -> string: String ``` -## `#!sds fun` `size` {#safeds.lang.List.size data-toc-label='[fun] size'} +## `size` {#safeds.lang.List.size data-toc-label='[function] size'} Return the number of elements in the list. @@ -135,7 +135,7 @@ pipeline example { fun size() -> size: Int ``` -## `#!sds fun` `slice` {#safeds.lang.List.slice data-toc-label='[fun] slice'} +## `slice` {#safeds.lang.List.slice data-toc-label='[function] slice'} Return the slice of the list starting at the start index up to but excluding the end index. diff --git a/docs/api/safeds/lang/Map.md b/docs/api/safeds/lang/Map.md index a94669bbf..2a57aa09c 100644 --- a/docs/api/safeds/lang/Map.md +++ b/docs/api/safeds/lang/Map.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Map` {#safeds.lang.Map data-toc-label='[abstract class] Map'} +# `Map` {#safeds.lang.Map data-toc-label='[class] Map'} A map of keys to values. @@ -84,7 +84,7 @@ pipeline example { } ``` -## `#!sds fun` `keys` {#safeds.lang.Map.keys data-toc-label='[fun] keys'} +## `keys` {#safeds.lang.Map.keys data-toc-label='[function] keys'} Return the keys of the map. @@ -115,7 +115,7 @@ pipeline example { fun keys() -> keys: List ``` -## `#!sds fun` `size` {#safeds.lang.Map.size data-toc-label='[fun] size'} +## `size` {#safeds.lang.Map.size data-toc-label='[function] size'} Return the number of entries in the map. @@ -146,7 +146,7 @@ pipeline example { fun size() -> size: Int ``` -## `#!sds fun` `values` {#safeds.lang.Map.values data-toc-label='[fun] values'} +## `values` {#safeds.lang.Map.values data-toc-label='[function] values'} Return the values of the map. diff --git a/docs/api/safeds/lang/Nothing.md b/docs/api/safeds/lang/Nothing.md index eed3d5c96..7b492ec45 100644 --- a/docs/api/safeds/lang/Nothing.md +++ b/docs/api/safeds/lang/Nothing.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Nothing` {#safeds.lang.Nothing data-toc-label='[abstract class] Nothing'} +# `Nothing` {#safeds.lang.Nothing data-toc-label='[class] Nothing'} The common subclass of all classes. diff --git a/docs/api/safeds/lang/Number.md b/docs/api/safeds/lang/Number.md index 490691dc1..5703ced3b 100644 --- a/docs/api/safeds/lang/Number.md +++ b/docs/api/safeds/lang/Number.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Number` {#safeds.lang.Number data-toc-label='[abstract class] Number'} +# `Number` {#safeds.lang.Number data-toc-label='[class] Number'} A number. diff --git a/docs/api/safeds/lang/Pure.md b/docs/api/safeds/lang/Pure.md index 90cc31877..a2a049fa5 100644 --- a/docs/api/safeds/lang/Pure.md +++ b/docs/api/safeds/lang/Pure.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds annotation` `Pure` {#safeds.lang.Pure data-toc-label='[annotation] Pure'} +# :test_tube:{ title="Experimental" } `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. diff --git a/docs/api/safeds/lang/PythonMacro.md b/docs/api/safeds/lang/PythonMacro.md index 20d0c2b82..836cd36ba 100644 --- a/docs/api/safeds/lang/PythonMacro.md +++ b/docs/api/safeds/lang/PythonMacro.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds annotation` `PythonMacro` {#safeds.lang.PythonMacro data-toc-label='[annotation] PythonMacro'} +# :test_tube:{ title="Experimental" } `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. diff --git a/docs/api/safeds/lang/PythonModule.md b/docs/api/safeds/lang/PythonModule.md index 437f24563..0990eeecb 100644 --- a/docs/api/safeds/lang/PythonModule.md +++ b/docs/api/safeds/lang/PythonModule.md @@ -1,4 +1,4 @@ -# `#!sds annotation` `PythonModule` {#safeds.lang.PythonModule data-toc-label='[annotation] PythonModule'} +# `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 stubs. diff --git a/docs/api/safeds/lang/PythonName.md b/docs/api/safeds/lang/PythonName.md index 73c30b899..2bb1b0f32 100644 --- a/docs/api/safeds/lang/PythonName.md +++ b/docs/api/safeds/lang/PythonName.md @@ -1,4 +1,4 @@ -# `#!sds annotation` `PythonName` {#safeds.lang.PythonName data-toc-label='[annotation] PythonName'} +# `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. diff --git a/docs/api/safeds/lang/Repeatable.md b/docs/api/safeds/lang/Repeatable.md index 57192ed96..a155e0161 100644 --- a/docs/api/safeds/lang/Repeatable.md +++ b/docs/api/safeds/lang/Repeatable.md @@ -1,4 +1,4 @@ -# `#!sds annotation` `Repeatable` {#safeds.lang.Repeatable data-toc-label='[annotation] Repeatable'} +# `Repeatable` {#safeds.lang.Repeatable data-toc-label='[annotation] Repeatable'} The annotation can be called multiple times for the same declaration. diff --git a/docs/api/safeds/lang/String.md b/docs/api/safeds/lang/String.md index 9a517f6b7..43145d12d 100644 --- a/docs/api/safeds/lang/String.md +++ b/docs/api/safeds/lang/String.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `String` {#safeds.lang.String data-toc-label='[abstract class] String'} +# `String` {#safeds.lang.String data-toc-label='[class] String'} Some text. @@ -270,7 +270,7 @@ pipeline example { } ``` -## `#!sds fun` `contains` {#safeds.lang.String.contains data-toc-label='[fun] contains'} +## `contains` {#safeds.lang.String.contains data-toc-label='[function] contains'} Check if the string contains the substring. @@ -302,7 +302,7 @@ pipeline example { fun contains(substring: String) -> contains: Boolean ``` -## `#!sds fun` `endsWith` {#safeds.lang.String.endsWith data-toc-label='[fun] endsWith'} +## `endsWith` {#safeds.lang.String.endsWith data-toc-label='[function] endsWith'} Check if the string ends with the suffix. @@ -334,7 +334,7 @@ pipeline example { fun endsWith(suffix: String) -> endsWith: Boolean ``` -## `#!sds fun` `indexOf` {#safeds.lang.String.indexOf data-toc-label='[fun] indexOf'} +## `indexOf` {#safeds.lang.String.indexOf data-toc-label='[function] indexOf'} Return the index of the first occurrence of the substring in the string or -1 if the substring is not found. @@ -366,7 +366,7 @@ pipeline example { fun indexOf(substring: String) -> index: Int ``` -## `#!sds fun` `lastIndexOf` {#safeds.lang.String.lastIndexOf data-toc-label='[fun] lastIndexOf'} +## `lastIndexOf` {#safeds.lang.String.lastIndexOf data-toc-label='[function] lastIndexOf'} Return the index of the last occurrence of the substring in the string or -1 if the substring is not found. @@ -398,7 +398,7 @@ pipeline example { fun lastIndexOf(substring: String) -> index: Int ``` -## `#!sds fun` `length` {#safeds.lang.String.length data-toc-label='[fun] length'} +## `length` {#safeds.lang.String.length data-toc-label='[function] length'} Return the number of characters in the string. @@ -424,7 +424,7 @@ pipeline example { fun length() -> length: Int ``` -## `#!sds fun` `repeat` {#safeds.lang.String.repeat data-toc-label='[fun] repeat'} +## `repeat` {#safeds.lang.String.repeat data-toc-label='[function] repeat'} Repeat the string n times. @@ -456,7 +456,7 @@ pipeline example { fun repeat(n: Int) -> repeatedString: String ``` -## `#!sds fun` `replace` {#safeds.lang.String.replace data-toc-label='[fun] replace'} +## `replace` {#safeds.lang.String.replace data-toc-label='[function] replace'} Replace all occurrences of the old substring with the new substring. @@ -489,7 +489,7 @@ pipeline example { fun replace(old: String, new: String) -> replacedString: String ``` -## `#!sds fun` `split` {#safeds.lang.String.split data-toc-label='[fun] split'} +## `split` {#safeds.lang.String.split data-toc-label='[function] split'} Split the string into parts using the separator. @@ -521,7 +521,7 @@ pipeline example { fun split(separator: String) -> parts: List ``` -## `#!sds fun` `startsWith` {#safeds.lang.String.startsWith data-toc-label='[fun] startsWith'} +## `startsWith` {#safeds.lang.String.startsWith data-toc-label='[function] startsWith'} Check if the string starts with the prefix. @@ -553,7 +553,7 @@ pipeline example { fun startsWith(prefix: String) -> startsWith: Boolean ``` -## `#!sds fun` `substring` {#safeds.lang.String.substring data-toc-label='[fun] substring'} +## `substring` {#safeds.lang.String.substring data-toc-label='[function] substring'} Return the substring of the string starting at the start index up to but excluding the end index. @@ -586,7 +586,7 @@ pipeline example { fun substring(start: Int = 0, end: Int = this.length()) -> substring: String ``` -## `#!sds fun` `toCasefolded` {#safeds.lang.String.toCasefolded data-toc-label='[fun] toCasefolded'} +## `toCasefolded` {#safeds.lang.String.toCasefolded data-toc-label='[function] toCasefolded'} Normalize the casing of a string to make it suitable for case-insensitive matching. This is essentially a more aggressive form of lowercasing. For example, the German lowercase letter "ß" gets converted to "ss". @@ -620,7 +620,7 @@ pipeline example { fun toCasefolded() -> casefolded: String ``` -## `#!sds fun` `toFloat` {#safeds.lang.String.toFloat data-toc-label='[fun] toFloat'} +## `toFloat` {#safeds.lang.String.toFloat data-toc-label='[function] toFloat'} Parse the string to a floating-point number. @@ -646,7 +646,7 @@ pipeline example { fun toFloat() -> float: Float ``` -## `#!sds fun` `toInt` {#safeds.lang.String.toInt data-toc-label='[fun] toInt'} +## `toInt` {#safeds.lang.String.toInt data-toc-label='[function] toInt'} Parse the string to an integer. @@ -683,7 +683,7 @@ pipeline example { fun toInt(base: Int = 10) -> int: Int ``` -## `#!sds fun` `toLowercase` {#safeds.lang.String.toLowercase data-toc-label='[fun] toLowercase'} +## `toLowercase` {#safeds.lang.String.toLowercase data-toc-label='[function] toLowercase'} Convert the string to lowercase. Prefer [String.toCasefolded][safeds.lang.String.toCasefolded] for case-insensitive matching. @@ -716,7 +716,7 @@ pipeline example { fun toLowercase() -> lowercase: String ``` -## `#!sds fun` `toUppercase` {#safeds.lang.String.toUppercase data-toc-label='[fun] toUppercase'} +## `toUppercase` {#safeds.lang.String.toUppercase data-toc-label='[function] toUppercase'} Convert the string to uppercase. Prefer [String.toCasefolded][safeds.lang.String.toCasefolded] for case-insensitive matching. @@ -749,7 +749,7 @@ pipeline example { fun toUppercase() -> uppercase: String ``` -## `#!sds fun` `trim` {#safeds.lang.String.trim data-toc-label='[fun] trim'} +## `trim` {#safeds.lang.String.trim data-toc-label='[function] trim'} Trim leading and trailing whitespace from the string. @@ -775,7 +775,7 @@ pipeline example { fun trim() -> trimmed: String ``` -## `#!sds fun` `trimEnd` {#safeds.lang.String.trimEnd data-toc-label='[fun] trimEnd'} +## `trimEnd` {#safeds.lang.String.trimEnd data-toc-label='[function] trimEnd'} Trim trailing whitespace from the string. @@ -801,7 +801,7 @@ pipeline example { fun trimEnd() -> trimmed: String ``` -## `#!sds fun` `trimStart` {#safeds.lang.String.trimStart data-toc-label='[fun] trimStart'} +## `trimStart` {#safeds.lang.String.trimStart data-toc-label='[function] trimStart'} Trim leading whitespace from the string. diff --git a/docs/api/safeds/lang/Tags.md b/docs/api/safeds/lang/Tags.md index e45b8fe01..06d39664f 100644 --- a/docs/api/safeds/lang/Tags.md +++ b/docs/api/safeds/lang/Tags.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds annotation` `Tags` {#safeds.lang.Tags data-toc-label='[annotation] Tags'} +# :test_tube:{ title="Experimental" } `Tags` {#safeds.lang.Tags data-toc-label='[annotation] Tags'} Tags to associate with a declaration. They can be used for filtering. diff --git a/docs/api/safeds/lang/Targets.md b/docs/api/safeds/lang/Targets.md index 99a4a82cd..b86c11812 100644 --- a/docs/api/safeds/lang/Targets.md +++ b/docs/api/safeds/lang/Targets.md @@ -1,4 +1,4 @@ -# `#!sds annotation` `Targets` {#safeds.lang.Targets data-toc-label='[annotation] Targets'} +# `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. diff --git a/docs/api/safeds/ml/classical/SupervisedModel.md b/docs/api/safeds/ml/classical/SupervisedModel.md index b5e6582d7..cfcd96567 100644 --- a/docs/api/safeds/ml/classical/SupervisedModel.md +++ b/docs/api/safeds/ml/classical/SupervisedModel.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `SupervisedModel` {#safeds.ml.classical.SupervisedModel data-toc-label='[abstract class] SupervisedModel'} +# `SupervisedModel` {#safeds.ml.classical.SupervisedModel data-toc-label='[class] SupervisedModel'} A model for supervised learning tasks. @@ -95,13 +95,13 @@ A model for supervised learning tasks. } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.SupervisedModel.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.SupervisedModel.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.ml.classical.SupervisedModel.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.SupervisedModel.fit data-toc-label='[function] fit'} Create a copy of this model and fit it with the given training data. @@ -128,7 +128,7 @@ Create a copy of this model and fit it with the given training data. ) -> fittedModel: SupervisedModel ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.SupervisedModel.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.SupervisedModel.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -148,7 +148,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.SupervisedModel.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.SupervisedModel.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -168,7 +168,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.SupervisedModel.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.SupervisedModel.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -188,7 +188,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.SupervisedModel.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.SupervisedModel.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -208,7 +208,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `predict` {#safeds.ml.classical.SupervisedModel.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.SupervisedModel.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. diff --git a/docs/api/safeds/ml/classical/classification/AdaBoostClassifier.md b/docs/api/safeds/ml/classical/classification/AdaBoostClassifier.md index e643d2c11..41bc86210 100644 --- a/docs/api/safeds/ml/classical/classification/AdaBoostClassifier.md +++ b/docs/api/safeds/ml/classical/classification/AdaBoostClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `AdaBoostClassifier` {#safeds.ml.classical.classification.AdaBoostClassifier data-toc-label='[class] AdaBoostClassifier'} +# `AdaBoostClassifier` {#safeds.ml.classical.classification.AdaBoostClassifier data-toc-label='[class] AdaBoostClassifier'} Ada Boost classification. @@ -63,31 +63,31 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.AdaBoostClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.AdaBoostClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `learner` {#safeds.ml.classical.classification.AdaBoostClassifier.learner data-toc-label='[attr] learner'} +## `learner` {#safeds.ml.classical.classification.AdaBoostClassifier.learner data-toc-label='[attribute] learner'} Get the base learner used for training the ensemble. **Type:** [`Classifier`][safeds.ml.classical.classification.Classifier] -## `#!sds attr` `learningRate` {#safeds.ml.classical.classification.AdaBoostClassifier.learningRate data-toc-label='[attr] learningRate'} +## `learningRate` {#safeds.ml.classical.classification.AdaBoostClassifier.learningRate data-toc-label='[attribute] learningRate'} Get the learning rate. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `maxLearnerCount` {#safeds.ml.classical.classification.AdaBoostClassifier.maxLearnerCount data-toc-label='[attr] maxLearnerCount'} +## `maxLearnerCount` {#safeds.ml.classical.classification.AdaBoostClassifier.maxLearnerCount data-toc-label='[attribute] maxLearnerCount'} Get the maximum number of learners in the ensemble. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.AdaBoostClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.AdaBoostClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -117,7 +117,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.AdaBoostClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.AdaBoostClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -150,7 +150,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.AdaBoostClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.AdaBoostClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -177,7 +177,7 @@ This classifier is not modified. ) -> fittedClassifier: AdaBoostClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.AdaBoostClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.AdaBoostClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -197,7 +197,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.AdaBoostClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.AdaBoostClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -217,7 +217,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.AdaBoostClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.AdaBoostClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -237,7 +237,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.AdaBoostClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.AdaBoostClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -257,7 +257,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.AdaBoostClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.AdaBoostClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -289,7 +289,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.AdaBoostClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.AdaBoostClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -316,7 +316,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.AdaBoostClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.AdaBoostClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -348,7 +348,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.AdaBoostClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.AdaBoostClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/Classifier.md b/docs/api/safeds/ml/classical/classification/Classifier.md index 1242a0f1c..fb360a995 100644 --- a/docs/api/safeds/ml/classical/classification/Classifier.md +++ b/docs/api/safeds/ml/classical/classification/Classifier.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Classifier` {#safeds.ml.classical.classification.Classifier data-toc-label='[abstract class] Classifier'} +# `Classifier` {#safeds.ml.classical.classification.Classifier data-toc-label='[class] Classifier'} A model for classification tasks. @@ -16,10 +16,8 @@ A model for classification tasks. - [`GradientBoostingClassifier`][safeds.ml.classical.classification.GradientBoostingClassifier] - [`KNearestNeighborsClassifier`][safeds.ml.classical.classification.KNearestNeighborsClassifier] - [`LogisticClassifier`][safeds.ml.classical.classification.LogisticClassifier] -- `#!sds LogisticRegressionClassifier` - [`RandomForestClassifier`][safeds.ml.classical.classification.RandomForestClassifier] - [`SupportVectorClassifier`][safeds.ml.classical.classification.SupportVectorClassifier] -- `#!sds SupportVectorMachineClassifier` ??? quote "Stub code in `Classifier.sdsstub`" @@ -133,13 +131,13 @@ A model for classification tasks. } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.Classifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.Classifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.Classifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.Classifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -169,7 +167,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.Classifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.Classifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -202,7 +200,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.Classifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.Classifier.fit data-toc-label='[function] fit'} Create a copy of this model and fit it with the given training data. @@ -229,7 +227,7 @@ Create a copy of this model and fit it with the given training data. ) -> fittedModel: Classifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.Classifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.Classifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -249,7 +247,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.Classifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.Classifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -269,7 +267,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.Classifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.Classifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -289,7 +287,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.Classifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.Classifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -309,7 +307,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.Classifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.Classifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -341,7 +339,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.Classifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.Classifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -368,7 +366,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.Classifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.Classifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -400,7 +398,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.Classifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.Classifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/DecisionTreeClassifier.md b/docs/api/safeds/ml/classical/classification/DecisionTreeClassifier.md index c39d87459..f8a2c1c11 100644 --- a/docs/api/safeds/ml/classical/classification/DecisionTreeClassifier.md +++ b/docs/api/safeds/ml/classical/classification/DecisionTreeClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `DecisionTreeClassifier` {#safeds.ml.classical.classification.DecisionTreeClassifier data-toc-label='[class] DecisionTreeClassifier'} +# `DecisionTreeClassifier` {#safeds.ml.classical.classification.DecisionTreeClassifier data-toc-label='[class] DecisionTreeClassifier'} Decision tree classification. @@ -56,25 +56,25 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.DecisionTreeClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.DecisionTreeClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `maxDepth` {#safeds.ml.classical.classification.DecisionTreeClassifier.maxDepth data-toc-label='[attr] maxDepth'} +## `maxDepth` {#safeds.ml.classical.classification.DecisionTreeClassifier.maxDepth data-toc-label='[attribute] maxDepth'} The maximum depth of the tree. **Type:** [`Int?`][safeds.lang.Int] -## `#!sds attr` `minSampleCountInLeaves` {#safeds.ml.classical.classification.DecisionTreeClassifier.minSampleCountInLeaves data-toc-label='[attr] minSampleCountInLeaves'} +## `minSampleCountInLeaves` {#safeds.ml.classical.classification.DecisionTreeClassifier.minSampleCountInLeaves data-toc-label='[attribute] minSampleCountInLeaves'} The minimum number of samples that must remain in the leaves of the tree. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.DecisionTreeClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.DecisionTreeClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -104,7 +104,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.DecisionTreeClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.DecisionTreeClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -137,7 +137,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.DecisionTreeClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.DecisionTreeClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -164,7 +164,7 @@ This classifier is not modified. ) -> fittedClassifier: DecisionTreeClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.DecisionTreeClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.DecisionTreeClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -184,7 +184,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.DecisionTreeClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.DecisionTreeClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -204,7 +204,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.DecisionTreeClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.DecisionTreeClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -224,7 +224,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.DecisionTreeClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.DecisionTreeClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -244,7 +244,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.DecisionTreeClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.DecisionTreeClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -276,7 +276,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.DecisionTreeClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.DecisionTreeClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -303,7 +303,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.DecisionTreeClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.DecisionTreeClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -335,7 +335,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.DecisionTreeClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.DecisionTreeClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/GradientBoostingClassifier.md b/docs/api/safeds/ml/classical/classification/GradientBoostingClassifier.md index 80659c576..0b0c0a05d 100644 --- a/docs/api/safeds/ml/classical/classification/GradientBoostingClassifier.md +++ b/docs/api/safeds/ml/classical/classification/GradientBoostingClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `GradientBoostingClassifier` {#safeds.ml.classical.classification.GradientBoostingClassifier data-toc-label='[class] GradientBoostingClassifier'} +# `GradientBoostingClassifier` {#safeds.ml.classical.classification.GradientBoostingClassifier data-toc-label='[class] GradientBoostingClassifier'} Gradient boosting classification. @@ -57,25 +57,25 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.GradientBoostingClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.GradientBoostingClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `learningRate` {#safeds.ml.classical.classification.GradientBoostingClassifier.learningRate data-toc-label='[attr] learningRate'} +## `learningRate` {#safeds.ml.classical.classification.GradientBoostingClassifier.learningRate data-toc-label='[attribute] learningRate'} Get the learning rate. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `treeCount` {#safeds.ml.classical.classification.GradientBoostingClassifier.treeCount data-toc-label='[attr] treeCount'} +## `treeCount` {#safeds.ml.classical.classification.GradientBoostingClassifier.treeCount data-toc-label='[attribute] treeCount'} Get the number of trees (estimators) in the ensemble. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.GradientBoostingClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.GradientBoostingClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -105,7 +105,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.GradientBoostingClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.GradientBoostingClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -138,7 +138,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.GradientBoostingClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.GradientBoostingClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -165,7 +165,7 @@ This classifier is not modified. ) -> fittedClassifier: GradientBoostingClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.GradientBoostingClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.GradientBoostingClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -185,7 +185,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.GradientBoostingClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.GradientBoostingClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -205,7 +205,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.GradientBoostingClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.GradientBoostingClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -225,7 +225,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.GradientBoostingClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.GradientBoostingClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -245,7 +245,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.GradientBoostingClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.GradientBoostingClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -277,7 +277,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.GradientBoostingClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.GradientBoostingClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -304,7 +304,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.GradientBoostingClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.GradientBoostingClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -336,7 +336,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.GradientBoostingClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.GradientBoostingClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/KNearestNeighborsClassifier.md b/docs/api/safeds/ml/classical/classification/KNearestNeighborsClassifier.md index 2d7325ffb..7c7c106fa 100644 --- a/docs/api/safeds/ml/classical/classification/KNearestNeighborsClassifier.md +++ b/docs/api/safeds/ml/classical/classification/KNearestNeighborsClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `KNearestNeighborsClassifier` {#safeds.ml.classical.classification.KNearestNeighborsClassifier data-toc-label='[class] KNearestNeighborsClassifier'} +# `KNearestNeighborsClassifier` {#safeds.ml.classical.classification.KNearestNeighborsClassifier data-toc-label='[class] KNearestNeighborsClassifier'} K-nearest-neighbors classification. @@ -50,19 +50,19 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `neighborCount` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.neighborCount data-toc-label='[attr] neighborCount'} +## `neighborCount` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.neighborCount data-toc-label='[attribute] neighborCount'} Get the number of neighbors used for interpolation. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -92,7 +92,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -125,7 +125,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -152,7 +152,7 @@ This classifier is not modified. ) -> fittedClassifier: KNearestNeighborsClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -172,7 +172,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -192,7 +192,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -212,7 +212,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -232,7 +232,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -264,7 +264,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -291,7 +291,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -323,7 +323,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.KNearestNeighborsClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/LogisticClassifier.md b/docs/api/safeds/ml/classical/classification/LogisticClassifier.md index a8c823c03..af43a1164 100644 --- a/docs/api/safeds/ml/classical/classification/LogisticClassifier.md +++ b/docs/api/safeds/ml/classical/classification/LogisticClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `LogisticClassifier` {#safeds.ml.classical.classification.LogisticClassifier data-toc-label='[class] LogisticClassifier'} +# `LogisticClassifier` {#safeds.ml.classical.classification.LogisticClassifier data-toc-label='[class] LogisticClassifier'} Regularized logistic regression. @@ -35,13 +35,13 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.LogisticClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.LogisticClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.LogisticClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.LogisticClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -71,7 +71,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.LogisticClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.LogisticClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -104,7 +104,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.LogisticClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.LogisticClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -131,7 +131,7 @@ This classifier is not modified. ) -> fittedClassifier: LogisticClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.LogisticClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.LogisticClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -151,7 +151,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.LogisticClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.LogisticClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -171,7 +171,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.LogisticClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.LogisticClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -191,7 +191,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.LogisticClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.LogisticClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -211,7 +211,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.LogisticClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.LogisticClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -243,7 +243,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.LogisticClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.LogisticClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -270,7 +270,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.LogisticClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.LogisticClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -302,7 +302,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.LogisticClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.LogisticClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/RandomForestClassifier.md b/docs/api/safeds/ml/classical/classification/RandomForestClassifier.md index d6a175ca0..09ee8c075 100644 --- a/docs/api/safeds/ml/classical/classification/RandomForestClassifier.md +++ b/docs/api/safeds/ml/classical/classification/RandomForestClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `RandomForestClassifier` {#safeds.ml.classical.classification.RandomForestClassifier data-toc-label='[class] RandomForestClassifier'} +# `RandomForestClassifier` {#safeds.ml.classical.classification.RandomForestClassifier data-toc-label='[class] RandomForestClassifier'} Random forest classification. @@ -63,31 +63,31 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.RandomForestClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.RandomForestClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `maxDepth` {#safeds.ml.classical.classification.RandomForestClassifier.maxDepth data-toc-label='[attr] maxDepth'} +## `maxDepth` {#safeds.ml.classical.classification.RandomForestClassifier.maxDepth data-toc-label='[attribute] maxDepth'} The maximum depth of each tree. **Type:** [`Int?`][safeds.lang.Int] -## `#!sds attr` `minSampleCountInLeaves` {#safeds.ml.classical.classification.RandomForestClassifier.minSampleCountInLeaves data-toc-label='[attr] minSampleCountInLeaves'} +## `minSampleCountInLeaves` {#safeds.ml.classical.classification.RandomForestClassifier.minSampleCountInLeaves data-toc-label='[attribute] minSampleCountInLeaves'} The minimum number of samples that must remain in the leaves of each tree. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `treeCount` {#safeds.ml.classical.classification.RandomForestClassifier.treeCount data-toc-label='[attr] treeCount'} +## `treeCount` {#safeds.ml.classical.classification.RandomForestClassifier.treeCount data-toc-label='[attribute] treeCount'} Get the number of trees used in the random forest. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.RandomForestClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.RandomForestClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -117,7 +117,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.RandomForestClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.RandomForestClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -150,7 +150,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.RandomForestClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.RandomForestClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -177,7 +177,7 @@ This classifier is not modified. ) -> fittedClassifier: RandomForestClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.RandomForestClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.RandomForestClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -197,7 +197,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.RandomForestClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.RandomForestClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -217,7 +217,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.RandomForestClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.RandomForestClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -237,7 +237,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.RandomForestClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.RandomForestClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -257,7 +257,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.RandomForestClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.RandomForestClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -289,7 +289,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.RandomForestClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.RandomForestClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -316,7 +316,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.RandomForestClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.RandomForestClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -348,7 +348,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.RandomForestClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.RandomForestClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/classification/SupportVectorClassifier.md b/docs/api/safeds/ml/classical/classification/SupportVectorClassifier.md index 11c4125bd..d714af697 100644 --- a/docs/api/safeds/ml/classical/classification/SupportVectorClassifier.md +++ b/docs/api/safeds/ml/classical/classification/SupportVectorClassifier.md @@ -1,4 +1,4 @@ -# `#!sds class` `SupportVectorClassifier` {#safeds.ml.classical.classification.SupportVectorClassifier data-toc-label='[class] SupportVectorClassifier'} +# `SupportVectorClassifier` {#safeds.ml.classical.classification.SupportVectorClassifier data-toc-label='[class] SupportVectorClassifier'} Support vector machine for classification. @@ -91,25 +91,25 @@ pipeline example { } ``` -## `#!sds attr` `c` {#safeds.ml.classical.classification.SupportVectorClassifier.c data-toc-label='[attr] c'} +## `c` {#safeds.ml.classical.classification.SupportVectorClassifier.c data-toc-label='[attribute] c'} Get the regularization strength. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `isFitted` {#safeds.ml.classical.classification.SupportVectorClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.classification.SupportVectorClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `kernel` {#safeds.ml.classical.classification.SupportVectorClassifier.kernel data-toc-label='[attr] kernel'} +## `kernel` {#safeds.ml.classical.classification.SupportVectorClassifier.kernel data-toc-label='[attribute] kernel'} Get the type of kernel used. **Type:** [`Kernel`][safeds.ml.classical.classification.SupportVectorClassifier.Kernel] -## `#!sds fun` `accuracy` {#safeds.ml.classical.classification.SupportVectorClassifier.accuracy data-toc-label='[fun] accuracy'} +## `accuracy` {#safeds.ml.classical.classification.SupportVectorClassifier.accuracy data-toc-label='[function] accuracy'} Compute the accuracy of the classifier on the given data. @@ -139,7 +139,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds fun` `f1Score` {#safeds.ml.classical.classification.SupportVectorClassifier.f1Score data-toc-label='[fun] f1Score'} +## `f1Score` {#safeds.ml.classical.classification.SupportVectorClassifier.f1Score data-toc-label='[function] f1Score'} Compute the classifier's F₁ score on the given data. @@ -172,7 +172,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.classification.SupportVectorClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.classification.SupportVectorClassifier.fit data-toc-label='[function] fit'} Create a copy of this classifier and fit it with the given training data. @@ -199,7 +199,7 @@ This classifier is not modified. ) -> fittedClassifier: SupportVectorClassifier ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.classification.SupportVectorClassifier.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.classification.SupportVectorClassifier.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -219,7 +219,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.classification.SupportVectorClassifier.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.classification.SupportVectorClassifier.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -239,7 +239,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.classification.SupportVectorClassifier.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.classification.SupportVectorClassifier.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -259,7 +259,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.classification.SupportVectorClassifier.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.classification.SupportVectorClassifier.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -279,7 +279,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `precision` {#safeds.ml.classical.classification.SupportVectorClassifier.precision data-toc-label='[fun] precision'} +## `precision` {#safeds.ml.classical.classification.SupportVectorClassifier.precision data-toc-label='[function] precision'} Compute the classifier's precision on the given data. @@ -311,7 +311,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.classification.SupportVectorClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.classification.SupportVectorClassifier.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -338,7 +338,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `recall` {#safeds.ml.classical.classification.SupportVectorClassifier.recall data-toc-label='[fun] recall'} +## `recall` {#safeds.ml.classical.classification.SupportVectorClassifier.recall data-toc-label='[function] recall'} Compute the classifier's recall on the given data. @@ -370,7 +370,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.classification.SupportVectorClassifier.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.classification.SupportVectorClassifier.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the classifier's metrics on the given data. @@ -400,7 +400,7 @@ Summarize the classifier's metrics on the given data. ) -> metrics: Table ``` -## `#!sds enum` `Kernel` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel data-toc-label='[enum] Kernel'} +## `Kernel` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel data-toc-label='[enum] Kernel'} The kernel functions that can be used in the support vector machine. @@ -438,11 +438,11 @@ The kernel functions that can be used in the support vector machine. } ``` -### `Linear` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.Linear data-toc-label='Linear'} +### `Linear` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.Linear data-toc-label='[variant] Linear'} A linear kernel. -### `Polynomial` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.Polynomial data-toc-label='Polynomial'} +### `Polynomial` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.Polynomial data-toc-label='[variant] Polynomial'} A polynomial kernel. @@ -452,10 +452,10 @@ A polynomial kernel. |------|------|-------------|---------| | `degree` | [`Int`][safeds.lang.Int] | The degree of the polynomial. | - | -### `RadialBasisFunction` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.RadialBasisFunction data-toc-label='RadialBasisFunction'} +### `RadialBasisFunction` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.RadialBasisFunction data-toc-label='[variant] RadialBasisFunction'} A radial basis function kernel. -### `Sigmoid` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.Sigmoid data-toc-label='Sigmoid'} +### `Sigmoid` {#safeds.ml.classical.classification.SupportVectorClassifier.Kernel.Sigmoid data-toc-label='[variant] Sigmoid'} A sigmoid kernel. diff --git a/docs/api/safeds/ml/classical/regression/AdaBoostRegressor.md b/docs/api/safeds/ml/classical/regression/AdaBoostRegressor.md index ba65d6547..219de9860 100644 --- a/docs/api/safeds/ml/classical/regression/AdaBoostRegressor.md +++ b/docs/api/safeds/ml/classical/regression/AdaBoostRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `AdaBoostRegressor` {#safeds.ml.classical.regression.AdaBoostRegressor data-toc-label='[class] AdaBoostRegressor'} +# `AdaBoostRegressor` {#safeds.ml.classical.regression.AdaBoostRegressor data-toc-label='[class] AdaBoostRegressor'} Ada Boost regression. @@ -63,31 +63,31 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.AdaBoostRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.AdaBoostRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `learner` {#safeds.ml.classical.regression.AdaBoostRegressor.learner data-toc-label='[attr] learner'} +## `learner` {#safeds.ml.classical.regression.AdaBoostRegressor.learner data-toc-label='[attribute] learner'} Get the base learner used for training the ensemble. **Type:** [`Regressor`][safeds.ml.classical.regression.Regressor] -## `#!sds attr` `learningRate` {#safeds.ml.classical.regression.AdaBoostRegressor.learningRate data-toc-label='[attr] learningRate'} +## `learningRate` {#safeds.ml.classical.regression.AdaBoostRegressor.learningRate data-toc-label='[attribute] learningRate'} Get the learning rate. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `maxLearnerCount` {#safeds.ml.classical.regression.AdaBoostRegressor.maxLearnerCount data-toc-label='[attr] maxLearnerCount'} +## `maxLearnerCount` {#safeds.ml.classical.regression.AdaBoostRegressor.maxLearnerCount data-toc-label='[attribute] maxLearnerCount'} Get the maximum number of learners in the ensemble. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.AdaBoostRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.AdaBoostRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -128,7 +128,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.AdaBoostRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.AdaBoostRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -155,7 +155,7 @@ This regressor is not modified. ) -> fittedRegressor: AdaBoostRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.AdaBoostRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.AdaBoostRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -175,7 +175,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.AdaBoostRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.AdaBoostRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -195,7 +195,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.AdaBoostRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.AdaBoostRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -215,7 +215,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.AdaBoostRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.AdaBoostRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -235,7 +235,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.AdaBoostRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.AdaBoostRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -265,7 +265,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.AdaBoostRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.AdaBoostRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -299,7 +299,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.AdaBoostRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.AdaBoostRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -331,7 +331,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.AdaBoostRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.AdaBoostRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -361,7 +361,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.AdaBoostRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.AdaBoostRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -388,7 +388,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.AdaBoostRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.AdaBoostRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/ArimaRegressor.md b/docs/api/safeds/ml/classical/regression/ArimaRegressor.md index b258b461f..70df0e492 100644 --- a/docs/api/safeds/ml/classical/regression/ArimaRegressor.md +++ b/docs/api/safeds/ml/classical/regression/ArimaRegressor.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `ArimaRegressor` {#safeds.ml.classical.regression.ArimaRegressor data-toc-label='[class] ArimaRegressor'} +# :test_tube:{ title="Experimental" } `ArimaRegressor` {#safeds.ml.classical.regression.ArimaRegressor data-toc-label='[class] ArimaRegressor'} Auto Regressive Integrated Moving Average Model. @@ -60,13 +60,13 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.ArimaRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.ArimaRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the regressor is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.ml.classical.regression.ArimaRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.ArimaRegressor.fit data-toc-label='[function] fit'} Create a copy of this ARIMA Model and fit it with the given training data. @@ -93,7 +93,7 @@ This ARIMA Model is not modified. ) -> fittedArima: ArimaRegressor ``` -## `#!sds fun` `plotPredictions` {#safeds.ml.classical.regression.ArimaRegressor.plotPredictions data-toc-label='[fun] plotPredictions'} +## `plotPredictions` {#safeds.ml.classical.regression.ArimaRegressor.plotPredictions data-toc-label='[function] plotPredictions'} Plot the predictions of the trained model to the given target of the time series. So you can see the predictions and the actual values in one plot. @@ -119,7 +119,7 @@ Plot the predictions of the trained model to the given target of the time series ) -> image: Image ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.ArimaRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.ArimaRegressor.predict data-toc-label='[function] predict'} Predict a target vector using a time series target column. The model has to be trained first. diff --git a/docs/api/safeds/ml/classical/regression/DecisionTreeRegressor.md b/docs/api/safeds/ml/classical/regression/DecisionTreeRegressor.md index 3ebe7a0b0..308dc050a 100644 --- a/docs/api/safeds/ml/classical/regression/DecisionTreeRegressor.md +++ b/docs/api/safeds/ml/classical/regression/DecisionTreeRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `DecisionTreeRegressor` {#safeds.ml.classical.regression.DecisionTreeRegressor data-toc-label='[class] DecisionTreeRegressor'} +# `DecisionTreeRegressor` {#safeds.ml.classical.regression.DecisionTreeRegressor data-toc-label='[class] DecisionTreeRegressor'} Decision tree regression. @@ -56,25 +56,25 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.DecisionTreeRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.DecisionTreeRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `maxDepth` {#safeds.ml.classical.regression.DecisionTreeRegressor.maxDepth data-toc-label='[attr] maxDepth'} +## `maxDepth` {#safeds.ml.classical.regression.DecisionTreeRegressor.maxDepth data-toc-label='[attribute] maxDepth'} The maximum depth of the tree. **Type:** [`Int?`][safeds.lang.Int] -## `#!sds attr` `minSampleCountInLeaves` {#safeds.ml.classical.regression.DecisionTreeRegressor.minSampleCountInLeaves data-toc-label='[attr] minSampleCountInLeaves'} +## `minSampleCountInLeaves` {#safeds.ml.classical.regression.DecisionTreeRegressor.minSampleCountInLeaves data-toc-label='[attribute] minSampleCountInLeaves'} The minimum number of samples that must remain in the leaves of the tree. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.DecisionTreeRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.DecisionTreeRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -115,7 +115,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.DecisionTreeRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.DecisionTreeRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -142,7 +142,7 @@ This regressor is not modified. ) -> fittedRegressor: DecisionTreeRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.DecisionTreeRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.DecisionTreeRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -162,7 +162,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.DecisionTreeRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.DecisionTreeRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -182,7 +182,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.DecisionTreeRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.DecisionTreeRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -202,7 +202,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.DecisionTreeRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.DecisionTreeRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -222,7 +222,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.DecisionTreeRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.DecisionTreeRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -252,7 +252,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.DecisionTreeRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.DecisionTreeRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -286,7 +286,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.DecisionTreeRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.DecisionTreeRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -318,7 +318,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.DecisionTreeRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.DecisionTreeRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -348,7 +348,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.DecisionTreeRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.DecisionTreeRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -375,7 +375,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.DecisionTreeRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.DecisionTreeRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/ElasticNetRegressor.md b/docs/api/safeds/ml/classical/regression/ElasticNetRegressor.md index aa940fd51..5bc715b2b 100644 --- a/docs/api/safeds/ml/classical/regression/ElasticNetRegressor.md +++ b/docs/api/safeds/ml/classical/regression/ElasticNetRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `ElasticNetRegressor` {#safeds.ml.classical.regression.ElasticNetRegressor data-toc-label='[class] ElasticNetRegressor'} +# `ElasticNetRegressor` {#safeds.ml.classical.regression.ElasticNetRegressor data-toc-label='[class] ElasticNetRegressor'} Elastic net regression. @@ -58,25 +58,25 @@ pipeline example { } ``` -## `#!sds attr` `alpha` {#safeds.ml.classical.regression.ElasticNetRegressor.alpha data-toc-label='[attr] alpha'} +## `alpha` {#safeds.ml.classical.regression.ElasticNetRegressor.alpha data-toc-label='[attribute] alpha'} Get the regularization of the model. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.ElasticNetRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.ElasticNetRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `lassoRatio` {#safeds.ml.classical.regression.ElasticNetRegressor.lassoRatio data-toc-label='[attr] lassoRatio'} +## `lassoRatio` {#safeds.ml.classical.regression.ElasticNetRegressor.lassoRatio data-toc-label='[attribute] lassoRatio'} Get the ratio between Lasso and Ridge regularization. **Type:** [`Float`][safeds.lang.Float] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.ElasticNetRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.ElasticNetRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -117,7 +117,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.ElasticNetRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.ElasticNetRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -144,7 +144,7 @@ This regressor is not modified. ) -> fittedRegressor: ElasticNetRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.ElasticNetRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.ElasticNetRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -164,7 +164,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.ElasticNetRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.ElasticNetRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -184,7 +184,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.ElasticNetRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.ElasticNetRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -204,7 +204,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.ElasticNetRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.ElasticNetRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -224,7 +224,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.ElasticNetRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.ElasticNetRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -254,7 +254,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.ElasticNetRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.ElasticNetRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -288,7 +288,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.ElasticNetRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.ElasticNetRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -320,7 +320,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.ElasticNetRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.ElasticNetRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -350,7 +350,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.ElasticNetRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.ElasticNetRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -377,7 +377,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.ElasticNetRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.ElasticNetRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/GradientBoostingRegressor.md b/docs/api/safeds/ml/classical/regression/GradientBoostingRegressor.md index 601a6eb89..cc69bd2f2 100644 --- a/docs/api/safeds/ml/classical/regression/GradientBoostingRegressor.md +++ b/docs/api/safeds/ml/classical/regression/GradientBoostingRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `GradientBoostingRegressor` {#safeds.ml.classical.regression.GradientBoostingRegressor data-toc-label='[class] GradientBoostingRegressor'} +# `GradientBoostingRegressor` {#safeds.ml.classical.regression.GradientBoostingRegressor data-toc-label='[class] GradientBoostingRegressor'} Gradient boosting regression. @@ -57,25 +57,25 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.GradientBoostingRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.GradientBoostingRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `learningRate` {#safeds.ml.classical.regression.GradientBoostingRegressor.learningRate data-toc-label='[attr] learningRate'} +## `learningRate` {#safeds.ml.classical.regression.GradientBoostingRegressor.learningRate data-toc-label='[attribute] learningRate'} Get the learning rate. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `treeCount` {#safeds.ml.classical.regression.GradientBoostingRegressor.treeCount data-toc-label='[attr] treeCount'} +## `treeCount` {#safeds.ml.classical.regression.GradientBoostingRegressor.treeCount data-toc-label='[attribute] treeCount'} Get the number of trees (estimators) in the ensemble. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.GradientBoostingRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.GradientBoostingRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -116,7 +116,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.GradientBoostingRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.GradientBoostingRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -143,7 +143,7 @@ This regressor is not modified. ) -> fittedRegressor: GradientBoostingRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.GradientBoostingRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.GradientBoostingRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -163,7 +163,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.GradientBoostingRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.GradientBoostingRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -183,7 +183,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.GradientBoostingRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.GradientBoostingRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -203,7 +203,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.GradientBoostingRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.GradientBoostingRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -223,7 +223,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.GradientBoostingRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.GradientBoostingRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -253,7 +253,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.GradientBoostingRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.GradientBoostingRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -287,7 +287,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.GradientBoostingRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.GradientBoostingRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -319,7 +319,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.GradientBoostingRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.GradientBoostingRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -349,7 +349,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.GradientBoostingRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.GradientBoostingRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -376,7 +376,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.GradientBoostingRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.GradientBoostingRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/KNearestNeighborsRegressor.md b/docs/api/safeds/ml/classical/regression/KNearestNeighborsRegressor.md index 50d8bdb57..01fe4c71f 100644 --- a/docs/api/safeds/ml/classical/regression/KNearestNeighborsRegressor.md +++ b/docs/api/safeds/ml/classical/regression/KNearestNeighborsRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `KNearestNeighborsRegressor` {#safeds.ml.classical.regression.KNearestNeighborsRegressor data-toc-label='[class] KNearestNeighborsRegressor'} +# `KNearestNeighborsRegressor` {#safeds.ml.classical.regression.KNearestNeighborsRegressor data-toc-label='[class] KNearestNeighborsRegressor'} K-nearest-neighbors regression. @@ -50,19 +50,19 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `neighborCount` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.neighborCount data-toc-label='[attr] neighborCount'} +## `neighborCount` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.neighborCount data-toc-label='[attribute] neighborCount'} Get the number of neighbors used for interpolation. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -103,7 +103,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -130,7 +130,7 @@ This regressor is not modified. ) -> fittedRegressor: KNearestNeighborsRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -150,7 +150,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -170,7 +170,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -190,7 +190,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -210,7 +210,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -240,7 +240,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -274,7 +274,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -306,7 +306,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -336,7 +336,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -363,7 +363,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.KNearestNeighborsRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/LassoRegressor.md b/docs/api/safeds/ml/classical/regression/LassoRegressor.md index a0728a90d..02a7a863d 100644 --- a/docs/api/safeds/ml/classical/regression/LassoRegressor.md +++ b/docs/api/safeds/ml/classical/regression/LassoRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `LassoRegressor` {#safeds.ml.classical.regression.LassoRegressor data-toc-label='[class] LassoRegressor'} +# `LassoRegressor` {#safeds.ml.classical.regression.LassoRegressor data-toc-label='[class] LassoRegressor'} Lasso regression. @@ -50,19 +50,19 @@ pipeline example { } ``` -## `#!sds attr` `alpha` {#safeds.ml.classical.regression.LassoRegressor.alpha data-toc-label='[attr] alpha'} +## `alpha` {#safeds.ml.classical.regression.LassoRegressor.alpha data-toc-label='[attribute] alpha'} Get the regularization of the model. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.LassoRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.LassoRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.LassoRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.LassoRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -103,7 +103,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.LassoRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.LassoRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -130,7 +130,7 @@ This regressor is not modified. ) -> fittedRegressor: LassoRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.LassoRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.LassoRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -150,7 +150,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.LassoRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.LassoRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -170,7 +170,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.LassoRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.LassoRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -190,7 +190,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.LassoRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.LassoRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -210,7 +210,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.LassoRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.LassoRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -240,7 +240,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.LassoRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.LassoRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -274,7 +274,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.LassoRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.LassoRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -306,7 +306,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.LassoRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.LassoRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -336,7 +336,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.LassoRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.LassoRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -363,7 +363,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.LassoRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.LassoRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/LinearRegressor.md b/docs/api/safeds/ml/classical/regression/LinearRegressor.md index 2a74d27c8..9207ac4fd 100644 --- a/docs/api/safeds/ml/classical/regression/LinearRegressor.md +++ b/docs/api/safeds/ml/classical/regression/LinearRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `LinearRegressor` {#safeds.ml.classical.regression.LinearRegressor data-toc-label='[class] LinearRegressor'} +# `LinearRegressor` {#safeds.ml.classical.regression.LinearRegressor data-toc-label='[class] LinearRegressor'} Linear regression. @@ -35,13 +35,13 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.LinearRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.LinearRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.LinearRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.LinearRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -82,7 +82,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.LinearRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.LinearRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -109,7 +109,7 @@ This regressor is not modified. ) -> fittedRegressor: LinearRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.LinearRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.LinearRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -129,7 +129,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.LinearRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.LinearRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -149,7 +149,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.LinearRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.LinearRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -169,7 +169,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.LinearRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.LinearRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -189,7 +189,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.LinearRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.LinearRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -219,7 +219,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.LinearRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.LinearRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -253,7 +253,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.LinearRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.LinearRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -285,7 +285,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.LinearRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.LinearRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -315,7 +315,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.LinearRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.LinearRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -342,7 +342,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.LinearRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.LinearRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/RandomForestRegressor.md b/docs/api/safeds/ml/classical/regression/RandomForestRegressor.md index dbddfa6c4..104fb5180 100644 --- a/docs/api/safeds/ml/classical/regression/RandomForestRegressor.md +++ b/docs/api/safeds/ml/classical/regression/RandomForestRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `RandomForestRegressor` {#safeds.ml.classical.regression.RandomForestRegressor data-toc-label='[class] RandomForestRegressor'} +# `RandomForestRegressor` {#safeds.ml.classical.regression.RandomForestRegressor data-toc-label='[class] RandomForestRegressor'} Random forest regression. @@ -63,31 +63,31 @@ pipeline example { } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.RandomForestRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.RandomForestRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `maxDepth` {#safeds.ml.classical.regression.RandomForestRegressor.maxDepth data-toc-label='[attr] maxDepth'} +## `maxDepth` {#safeds.ml.classical.regression.RandomForestRegressor.maxDepth data-toc-label='[attribute] maxDepth'} The maximum depth of each tree. **Type:** [`Int?`][safeds.lang.Int] -## `#!sds attr` `minSampleCountInLeaves` {#safeds.ml.classical.regression.RandomForestRegressor.minSampleCountInLeaves data-toc-label='[attr] minSampleCountInLeaves'} +## `minSampleCountInLeaves` {#safeds.ml.classical.regression.RandomForestRegressor.minSampleCountInLeaves data-toc-label='[attribute] minSampleCountInLeaves'} The minimum number of samples that must remain in the leaves of each tree. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `treeCount` {#safeds.ml.classical.regression.RandomForestRegressor.treeCount data-toc-label='[attr] treeCount'} +## `treeCount` {#safeds.ml.classical.regression.RandomForestRegressor.treeCount data-toc-label='[attribute] treeCount'} Get the number of trees used in the random forest. **Type:** [`Int`][safeds.lang.Int] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.RandomForestRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.RandomForestRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -128,7 +128,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.RandomForestRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.RandomForestRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -155,7 +155,7 @@ This regressor is not modified. ) -> fittedRegressor: RandomForestRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.RandomForestRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.RandomForestRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -175,7 +175,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.RandomForestRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.RandomForestRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -195,7 +195,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.RandomForestRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.RandomForestRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -215,7 +215,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.RandomForestRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.RandomForestRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -235,7 +235,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.RandomForestRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.RandomForestRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -265,7 +265,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.RandomForestRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.RandomForestRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -299,7 +299,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.RandomForestRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.RandomForestRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -331,7 +331,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.RandomForestRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.RandomForestRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -361,7 +361,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.RandomForestRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.RandomForestRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -388,7 +388,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.RandomForestRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.RandomForestRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/Regressor.md b/docs/api/safeds/ml/classical/regression/Regressor.md index d66489d1d..98e44172f 100644 --- a/docs/api/safeds/ml/classical/regression/Regressor.md +++ b/docs/api/safeds/ml/classical/regression/Regressor.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# `#!sds abstract class` `Regressor` {#safeds.ml.classical.regression.Regressor data-toc-label='[abstract class] Regressor'} +# `Regressor` {#safeds.ml.classical.regression.Regressor data-toc-label='[class] Regressor'} A model for regression tasks. @@ -17,11 +17,9 @@ A model for regression tasks. - [`GradientBoostingRegressor`][safeds.ml.classical.regression.GradientBoostingRegressor] - [`KNearestNeighborsRegressor`][safeds.ml.classical.regression.KNearestNeighborsRegressor] - [`LassoRegressor`][safeds.ml.classical.regression.LassoRegressor] -- `#!sds LinearRegressionRegressor` - [`LinearRegressor`][safeds.ml.classical.regression.LinearRegressor] - [`RandomForestRegressor`][safeds.ml.classical.regression.RandomForestRegressor] - [`RidgeRegressor`][safeds.ml.classical.regression.RidgeRegressor] -- `#!sds SupportVectorMachineRegressor` - [`SupportVectorRegressor`][safeds.ml.classical.regression.SupportVectorRegressor] ??? quote "Stub code in `Regressor.sdsstub`" @@ -159,13 +157,13 @@ A model for regression tasks. } ``` -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.Regressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.Regressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.Regressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.Regressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -206,7 +204,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.Regressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.Regressor.fit data-toc-label='[function] fit'} Create a copy of this model and fit it with the given training data. @@ -233,7 +231,7 @@ Create a copy of this model and fit it with the given training data. ) -> fittedModel: Regressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.Regressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.Regressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -253,7 +251,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.Regressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.Regressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -273,7 +271,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.Regressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.Regressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -293,7 +291,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.Regressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.Regressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -313,7 +311,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.Regressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.Regressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -343,7 +341,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.Regressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.Regressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -377,7 +375,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.Regressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.Regressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -409,7 +407,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.Regressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.Regressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -439,7 +437,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.Regressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.Regressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -466,7 +464,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.Regressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.Regressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/RidgeRegressor.md b/docs/api/safeds/ml/classical/regression/RidgeRegressor.md index 4bf1465bd..f901f6e33 100644 --- a/docs/api/safeds/ml/classical/regression/RidgeRegressor.md +++ b/docs/api/safeds/ml/classical/regression/RidgeRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `RidgeRegressor` {#safeds.ml.classical.regression.RidgeRegressor data-toc-label='[class] RidgeRegressor'} +# `RidgeRegressor` {#safeds.ml.classical.regression.RidgeRegressor data-toc-label='[class] RidgeRegressor'} Ridge regression. @@ -50,19 +50,19 @@ pipeline example { } ``` -## `#!sds attr` `alpha` {#safeds.ml.classical.regression.RidgeRegressor.alpha data-toc-label='[attr] alpha'} +## `alpha` {#safeds.ml.classical.regression.RidgeRegressor.alpha data-toc-label='[attribute] alpha'} Get the regularization of the model. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.RidgeRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.RidgeRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.RidgeRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.RidgeRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -103,7 +103,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.RidgeRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.RidgeRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -130,7 +130,7 @@ This regressor is not modified. ) -> fittedRegressor: RidgeRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.RidgeRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.RidgeRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -150,7 +150,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.RidgeRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.RidgeRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -170,7 +170,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.RidgeRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.RidgeRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -190,7 +190,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.RidgeRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.RidgeRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -210,7 +210,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.RidgeRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.RidgeRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -240,7 +240,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.RidgeRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.RidgeRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -274,7 +274,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.RidgeRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.RidgeRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -306,7 +306,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.RidgeRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.RidgeRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -336,7 +336,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.RidgeRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.RidgeRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -363,7 +363,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.RidgeRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.RidgeRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. diff --git a/docs/api/safeds/ml/classical/regression/SupportVectorRegressor.md b/docs/api/safeds/ml/classical/regression/SupportVectorRegressor.md index 0ab550fc1..0971060ab 100644 --- a/docs/api/safeds/ml/classical/regression/SupportVectorRegressor.md +++ b/docs/api/safeds/ml/classical/regression/SupportVectorRegressor.md @@ -1,4 +1,4 @@ -# `#!sds class` `SupportVectorRegressor` {#safeds.ml.classical.regression.SupportVectorRegressor data-toc-label='[class] SupportVectorRegressor'} +# `SupportVectorRegressor` {#safeds.ml.classical.regression.SupportVectorRegressor data-toc-label='[class] SupportVectorRegressor'} Support vector machine for regression. @@ -91,25 +91,25 @@ pipeline example { } ``` -## `#!sds attr` `c` {#safeds.ml.classical.regression.SupportVectorRegressor.c data-toc-label='[attr] c'} +## `c` {#safeds.ml.classical.regression.SupportVectorRegressor.c data-toc-label='[attribute] c'} Get the regularization strength. **Type:** [`Float`][safeds.lang.Float] -## `#!sds attr` `isFitted` {#safeds.ml.classical.regression.SupportVectorRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.classical.regression.SupportVectorRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the model is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds attr` `kernel` {#safeds.ml.classical.regression.SupportVectorRegressor.kernel data-toc-label='[attr] kernel'} +## `kernel` {#safeds.ml.classical.regression.SupportVectorRegressor.kernel data-toc-label='[attribute] kernel'} Get the type of kernel used. **Type:** [`Kernel`][safeds.ml.classical.regression.SupportVectorRegressor.Kernel] -## `#!sds fun` `coefficientOfDetermination` {#safeds.ml.classical.regression.SupportVectorRegressor.coefficientOfDetermination data-toc-label='[fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.classical.regression.SupportVectorRegressor.coefficientOfDetermination data-toc-label='[function] coefficientOfDetermination'} Compute the coefficient of determination (R²) of the regressor on the given data. @@ -150,7 +150,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds fun` `fit` {#safeds.ml.classical.regression.SupportVectorRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.classical.regression.SupportVectorRegressor.fit data-toc-label='[function] fit'} Create a copy of this regressor and fit it with the given training data. @@ -177,7 +177,7 @@ This regressor is not modified. ) -> fittedRegressor: SupportVectorRegressor ``` -## `#!sds fun` `getFeatureNames` {#safeds.ml.classical.regression.SupportVectorRegressor.getFeatureNames data-toc-label='[fun] getFeatureNames'} +## `getFeatureNames` {#safeds.ml.classical.regression.SupportVectorRegressor.getFeatureNames data-toc-label='[function] getFeatureNames'} Return the names of the feature columns. @@ -197,7 +197,7 @@ Return the names of the feature columns. fun getFeatureNames() -> featureNames: List ``` -## `#!sds fun` `getFeaturesSchema` {#safeds.ml.classical.regression.SupportVectorRegressor.getFeaturesSchema data-toc-label='[fun] getFeaturesSchema'} +## `getFeaturesSchema` {#safeds.ml.classical.regression.SupportVectorRegressor.getFeaturesSchema data-toc-label='[function] getFeaturesSchema'} Return the schema of the feature columns. @@ -217,7 +217,7 @@ Return the schema of the feature columns. fun getFeaturesSchema() -> featureSchema: Schema ``` -## `#!sds fun` `getTargetName` {#safeds.ml.classical.regression.SupportVectorRegressor.getTargetName data-toc-label='[fun] getTargetName'} +## `getTargetName` {#safeds.ml.classical.regression.SupportVectorRegressor.getTargetName data-toc-label='[function] getTargetName'} Return the name of the target column. @@ -237,7 +237,7 @@ Return the name of the target column. fun getTargetName() -> targetName: String ``` -## `#!sds fun` `getTargetType` {#safeds.ml.classical.regression.SupportVectorRegressor.getTargetType data-toc-label='[fun] getTargetType'} +## `getTargetType` {#safeds.ml.classical.regression.SupportVectorRegressor.getTargetType data-toc-label='[function] getTargetType'} Return the type of the target column. @@ -257,7 +257,7 @@ Return the type of the target column. fun getTargetType() -> targetType: DataType ``` -## `#!sds fun` `meanAbsoluteError` {#safeds.ml.classical.regression.SupportVectorRegressor.meanAbsoluteError data-toc-label='[fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.classical.regression.SupportVectorRegressor.meanAbsoluteError data-toc-label='[function] meanAbsoluteError'} Compute the mean absolute error (MAE) of the regressor on the given data. @@ -287,7 +287,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds fun` `meanDirectionalAccuracy` {#safeds.ml.classical.regression.SupportVectorRegressor.meanDirectionalAccuracy data-toc-label='[fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.classical.regression.SupportVectorRegressor.meanDirectionalAccuracy data-toc-label='[function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) of the regressor on the given data. @@ -321,7 +321,7 @@ for other types of data. Because of this, it is not included in the `summarize_m ) -> meanDirectionalAccuracy: Float ``` -## `#!sds fun` `meanSquaredError` {#safeds.ml.classical.regression.SupportVectorRegressor.meanSquaredError data-toc-label='[fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.classical.regression.SupportVectorRegressor.meanSquaredError data-toc-label='[function] meanSquaredError'} Compute the mean squared error (MSE) of the regressor on the given data. @@ -353,7 +353,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds fun` `medianAbsoluteDeviation` {#safeds.ml.classical.regression.SupportVectorRegressor.medianAbsoluteDeviation data-toc-label='[fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.classical.regression.SupportVectorRegressor.medianAbsoluteDeviation data-toc-label='[function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) of the regressor on the given data. @@ -383,7 +383,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds fun` `predict` {#safeds.ml.classical.regression.SupportVectorRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.classical.regression.SupportVectorRegressor.predict data-toc-label='[function] predict'} Predict the target values on the given dataset. @@ -410,7 +410,7 @@ Predict the target values on the given dataset. ) -> prediction: TabularDataset ``` -## `#!sds fun` `summarizeMetrics` {#safeds.ml.classical.regression.SupportVectorRegressor.summarizeMetrics data-toc-label='[fun] summarizeMetrics'} +## `summarizeMetrics` {#safeds.ml.classical.regression.SupportVectorRegressor.summarizeMetrics data-toc-label='[function] summarizeMetrics'} Summarize the regressor's metrics on the given data. @@ -436,7 +436,7 @@ Summarize the regressor's metrics on the given data. ) -> metrics: Table ``` -## `#!sds enum` `Kernel` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel data-toc-label='[enum] Kernel'} +## `Kernel` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel data-toc-label='[enum] Kernel'} The kernel functions that can be used in the support vector machine. @@ -474,11 +474,11 @@ The kernel functions that can be used in the support vector machine. } ``` -### `Linear` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.Linear data-toc-label='Linear'} +### `Linear` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.Linear data-toc-label='[variant] Linear'} A linear kernel. -### `Polynomial` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.Polynomial data-toc-label='Polynomial'} +### `Polynomial` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.Polynomial data-toc-label='[variant] Polynomial'} A polynomial kernel. @@ -488,10 +488,10 @@ A polynomial kernel. |------|------|-------------|---------| | `degree` | [`Int`][safeds.lang.Int] | The degree of the polynomial. | - | -### `RadialBasisFunction` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.RadialBasisFunction data-toc-label='RadialBasisFunction'} +### `RadialBasisFunction` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.RadialBasisFunction data-toc-label='[variant] RadialBasisFunction'} A radial basis function kernel. -### `Sigmoid` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.Sigmoid data-toc-label='Sigmoid'} +### `Sigmoid` {#safeds.ml.classical.regression.SupportVectorRegressor.Kernel.Sigmoid data-toc-label='[variant] Sigmoid'} A sigmoid kernel. diff --git a/docs/api/safeds/ml/metrics/ClassificationMetrics.md b/docs/api/safeds/ml/metrics/ClassificationMetrics.md index 89de632b8..27f40f016 100644 --- a/docs/api/safeds/ml/metrics/ClassificationMetrics.md +++ b/docs/api/safeds/ml/metrics/ClassificationMetrics.md @@ -1,4 +1,4 @@ -# `#!sds abstract class` `ClassificationMetrics` {#safeds.ml.metrics.ClassificationMetrics data-toc-label='[abstract class] ClassificationMetrics'} +# `ClassificationMetrics` {#safeds.ml.metrics.ClassificationMetrics data-toc-label='[class] ClassificationMetrics'} A collection of classification metrics. @@ -99,7 +99,7 @@ A collection of classification metrics. } ``` -## `#!sds static fun` `accuracy` {#safeds.ml.metrics.ClassificationMetrics.accuracy data-toc-label='[static fun] accuracy'} +## `accuracy` {#safeds.ml.metrics.ClassificationMetrics.accuracy data-toc-label='[static-function] accuracy'} Compute the accuracy on the given data. @@ -129,7 +129,7 @@ better. Results range from 0.0 to 1.0. ) -> accuracy: Float ``` -## `#!sds static fun` `f1Score` {#safeds.ml.metrics.ClassificationMetrics.f1Score data-toc-label='[static fun] f1Score'} +## `f1Score` {#safeds.ml.metrics.ClassificationMetrics.f1Score data-toc-label='[static-function] f1Score'} Compute the F₁ score on the given data. @@ -162,7 +162,7 @@ classifier. Results range from 0.0 to 1.0. ) -> f1Score: Float ``` -## `#!sds static fun` `precision` {#safeds.ml.metrics.ClassificationMetrics.precision data-toc-label='[static fun] precision'} +## `precision` {#safeds.ml.metrics.ClassificationMetrics.precision data-toc-label='[static-function] precision'} Compute the precision on the given data. @@ -194,7 +194,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> precision: Float ``` -## `#!sds static fun` `recall` {#safeds.ml.metrics.ClassificationMetrics.recall data-toc-label='[static fun] recall'} +## `recall` {#safeds.ml.metrics.ClassificationMetrics.recall data-toc-label='[static-function] recall'} Compute the recall on the given data. @@ -226,7 +226,7 @@ better the classifier. Results range from 0.0 to 1.0. ) -> recall: Float ``` -## `#!sds static fun` `summarize` {#safeds.ml.metrics.ClassificationMetrics.summarize data-toc-label='[static fun] summarize'} +## `summarize` {#safeds.ml.metrics.ClassificationMetrics.summarize data-toc-label='[static-function] summarize'} Summarize classification metrics on the given data. diff --git a/docs/api/safeds/ml/metrics/RegressionMetrics.md b/docs/api/safeds/ml/metrics/RegressionMetrics.md index 098495ca6..f1dd1ff0a 100644 --- a/docs/api/safeds/ml/metrics/RegressionMetrics.md +++ b/docs/api/safeds/ml/metrics/RegressionMetrics.md @@ -1,4 +1,4 @@ -# `#!sds abstract class` `RegressionMetrics` {#safeds.ml.metrics.RegressionMetrics data-toc-label='[abstract class] RegressionMetrics'} +# `RegressionMetrics` {#safeds.ml.metrics.RegressionMetrics data-toc-label='[class] RegressionMetrics'} A collection of regression metrics. @@ -134,7 +134,7 @@ A collection of regression metrics. } ``` -## `#!sds static fun` `coefficientOfDetermination` {#safeds.ml.metrics.RegressionMetrics.coefficientOfDetermination data-toc-label='[static fun] coefficientOfDetermination'} +## `coefficientOfDetermination` {#safeds.ml.metrics.RegressionMetrics.coefficientOfDetermination data-toc-label='[static-function] coefficientOfDetermination'} Compute the coefficient of determination (R²) on the given data. @@ -177,7 +177,7 @@ to 1.0. You can interpret the coefficient of determination as follows: ) -> coefficientOfDetermination: Float ``` -## `#!sds static fun` `meanAbsoluteError` {#safeds.ml.metrics.RegressionMetrics.meanAbsoluteError data-toc-label='[static fun] meanAbsoluteError'} +## `meanAbsoluteError` {#safeds.ml.metrics.RegressionMetrics.meanAbsoluteError data-toc-label='[static-function] meanAbsoluteError'} Compute the mean absolute error (MAE) on the given data. @@ -209,7 +209,7 @@ infinity. ) -> meanAbsoluteError: Float ``` -## `#!sds static fun` `meanDirectionalAccuracy` {#safeds.ml.metrics.RegressionMetrics.meanDirectionalAccuracy data-toc-label='[static fun] meanDirectionalAccuracy'} +## `meanDirectionalAccuracy` {#safeds.ml.metrics.RegressionMetrics.meanDirectionalAccuracy data-toc-label='[static-function] meanDirectionalAccuracy'} Compute the mean directional accuracy (MDA) on the given data. @@ -245,7 +245,7 @@ for other types of data. Because of this, it is not included in the `summarize` ) -> meanDirectionalAccuracy: Float ``` -## `#!sds static fun` `meanSquaredError` {#safeds.ml.metrics.RegressionMetrics.meanSquaredError data-toc-label='[static fun] meanSquaredError'} +## `meanSquaredError` {#safeds.ml.metrics.RegressionMetrics.meanSquaredError data-toc-label='[static-function] meanSquaredError'} Compute the mean squared error (MSE) on the given data. @@ -279,7 +279,7 @@ infinity. ) -> meanSquaredError: Float ``` -## `#!sds static fun` `medianAbsoluteDeviation` {#safeds.ml.metrics.RegressionMetrics.medianAbsoluteDeviation data-toc-label='[static fun] medianAbsoluteDeviation'} +## `medianAbsoluteDeviation` {#safeds.ml.metrics.RegressionMetrics.medianAbsoluteDeviation data-toc-label='[static-function] medianAbsoluteDeviation'} Compute the median absolute deviation (MAD) on the given data. @@ -311,7 +311,7 @@ positive infinity. ) -> medianAbsoluteDeviation: Float ``` -## `#!sds static fun` `summarize` {#safeds.ml.metrics.RegressionMetrics.summarize data-toc-label='[static fun] summarize'} +## `summarize` {#safeds.ml.metrics.RegressionMetrics.summarize data-toc-label='[static-function] summarize'} Summarize regression metrics on the given data. diff --git a/docs/api/safeds/ml/nn/NeuralNetworkClassifier.md b/docs/api/safeds/ml/nn/NeuralNetworkClassifier.md index 3fe5e5b43..d6f8d3b4b 100644 --- a/docs/api/safeds/ml/nn/NeuralNetworkClassifier.md +++ b/docs/api/safeds/ml/nn/NeuralNetworkClassifier.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `NeuralNetworkClassifier` {#safeds.ml.nn.NeuralNetworkClassifier data-toc-label='[class] NeuralNetworkClassifier'} +# :test_tube:{ title="Experimental" } `NeuralNetworkClassifier` {#safeds.ml.nn.NeuralNetworkClassifier data-toc-label='[class] NeuralNetworkClassifier'} A NeuralNetworkClassifier is a neural network that is used for classification tasks. @@ -6,9 +6,9 @@ A NeuralNetworkClassifier is a neural network that is used for classification ta | Name | Type | Description | Default | |------|------|-------------|---------| -| `inputConversion` | `#!sds InputConversion` | to convert the input data for the neural network | - | +| `inputConversion` | [`InputConversion`][safeds.ml.nn.converters.InputConversion] | to convert the input data for the neural network | - | | `layers` | [`List`][safeds.lang.List] | a list of layers for the neural network to learn | - | -| `outputConversion` | `#!sds OutputConversion` | to convert the output data of the neural network back | - | +| `outputConversion` | [`OutputConversion`][safeds.ml.nn.converters.OutputConversion] | to convert the output data of the neural network back | - | **Type parameters:** @@ -84,13 +84,13 @@ A NeuralNetworkClassifier is a neural network that is used for classification ta } ``` -## `#!sds attr` `isFitted` {#safeds.ml.nn.NeuralNetworkClassifier.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.nn.NeuralNetworkClassifier.isFitted data-toc-label='[attribute] isFitted'} Whether the classifier is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.ml.nn.NeuralNetworkClassifier.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.nn.NeuralNetworkClassifier.fit data-toc-label='[function] fit'} Train the neural network with given training data. @@ -138,7 +138,7 @@ pipeline example { } ``` -## `#!sds fun` `predict` {#safeds.ml.nn.NeuralNetworkClassifier.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.nn.NeuralNetworkClassifier.predict data-toc-label='[function] predict'} Make a prediction for the given test data. diff --git a/docs/api/safeds/ml/nn/NeuralNetworkRegressor.md b/docs/api/safeds/ml/nn/NeuralNetworkRegressor.md index 8781c2ed7..48d2da94a 100644 --- a/docs/api/safeds/ml/nn/NeuralNetworkRegressor.md +++ b/docs/api/safeds/ml/nn/NeuralNetworkRegressor.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `NeuralNetworkRegressor` {#safeds.ml.nn.NeuralNetworkRegressor data-toc-label='[class] NeuralNetworkRegressor'} +# :test_tube:{ title="Experimental" } `NeuralNetworkRegressor` {#safeds.ml.nn.NeuralNetworkRegressor data-toc-label='[class] NeuralNetworkRegressor'} A NeuralNetworkRegressor is a neural network that is used for regression tasks. @@ -6,9 +6,9 @@ A NeuralNetworkRegressor is a neural network that is used for regression tasks. | Name | Type | Description | Default | |------|------|-------------|---------| -| `inputConversion` | `#!sds InputConversion` | to convert the input data for the neural network | - | +| `inputConversion` | [`InputConversion`][safeds.ml.nn.converters.InputConversion] | to convert the input data for the neural network | - | | `layers` | [`List`][safeds.lang.List] | a list of layers for the neural network to learn | - | -| `outputConversion` | `#!sds OutputConversion` | to convert the output data of the neural network back | - | +| `outputConversion` | [`OutputConversion`][safeds.ml.nn.converters.OutputConversion] | to convert the output data of the neural network back | - | **Type parameters:** @@ -84,13 +84,13 @@ A NeuralNetworkRegressor is a neural network that is used for regression tasks. } ``` -## `#!sds attr` `isFitted` {#safeds.ml.nn.NeuralNetworkRegressor.isFitted data-toc-label='[attr] isFitted'} +## `isFitted` {#safeds.ml.nn.NeuralNetworkRegressor.isFitted data-toc-label='[attribute] isFitted'} Whether the regressor is fitted. **Type:** [`Boolean`][safeds.lang.Boolean] -## `#!sds fun` `fit` {#safeds.ml.nn.NeuralNetworkRegressor.fit data-toc-label='[fun] fit'} +## `fit` {#safeds.ml.nn.NeuralNetworkRegressor.fit data-toc-label='[function] fit'} Train the neural network with given training data. @@ -138,7 +138,7 @@ pipeline example { } ``` -## `#!sds fun` `predict` {#safeds.ml.nn.NeuralNetworkRegressor.predict data-toc-label='[fun] predict'} +## `predict` {#safeds.ml.nn.NeuralNetworkRegressor.predict data-toc-label='[function] predict'} Make a prediction for the given test data. diff --git a/docs/api/safeds/ml/nn/converters/InputConversion.md b/docs/api/safeds/ml/nn/converters/InputConversion.md index 9c604be2e..b52dc929b 100644 --- a/docs/api/safeds/ml/nn/converters/InputConversion.md +++ b/docs/api/safeds/ml/nn/converters/InputConversion.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# :test_tube:{ title="Experimental" } `#!sds abstract class` `InputConversion` {#safeds.ml.nn.converters.InputConversion data-toc-label='[abstract class] InputConversion'} +# :test_tube:{ title="Experimental" } `InputConversion` {#safeds.ml.nn.converters.InputConversion data-toc-label='[class] InputConversion'} The input conversion for a neural network, defines the input parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/converters/InputConversionImage.md b/docs/api/safeds/ml/nn/converters/InputConversionImage.md index ab3bac96c..004a7f207 100644 --- a/docs/api/safeds/ml/nn/converters/InputConversionImage.md +++ b/docs/api/safeds/ml/nn/converters/InputConversionImage.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `InputConversionImage` {#safeds.ml.nn.converters.InputConversionImage data-toc-label='[class] InputConversionImage'} +# :test_tube:{ title="Experimental" } `InputConversionImage` {#safeds.ml.nn.converters.InputConversionImage data-toc-label='[class] InputConversionImage'} The input conversion for a neural network, defines the input parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/converters/InputConversionTable.md b/docs/api/safeds/ml/nn/converters/InputConversionTable.md index 41fbdc9f3..24668f830 100644 --- a/docs/api/safeds/ml/nn/converters/InputConversionTable.md +++ b/docs/api/safeds/ml/nn/converters/InputConversionTable.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `InputConversionTable` {#safeds.ml.nn.converters.InputConversionTable data-toc-label='[class] InputConversionTable'} +# :test_tube:{ title="Experimental" } `InputConversionTable` {#safeds.ml.nn.converters.InputConversionTable data-toc-label='[class] InputConversionTable'} The input conversion for a neural network defines the input parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/converters/InputConversionTimeSeries.md b/docs/api/safeds/ml/nn/converters/InputConversionTimeSeries.md index fe9f26fa7..f24d61980 100644 --- a/docs/api/safeds/ml/nn/converters/InputConversionTimeSeries.md +++ b/docs/api/safeds/ml/nn/converters/InputConversionTimeSeries.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `InputConversionTimeSeries` {#safeds.ml.nn.converters.InputConversionTimeSeries data-toc-label='[class] InputConversionTimeSeries'} +# :test_tube:{ title="Experimental" } `InputConversionTimeSeries` {#safeds.ml.nn.converters.InputConversionTimeSeries data-toc-label='[class] InputConversionTimeSeries'} The input conversion for a neural network, defines the input parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/converters/OutputConversion.md b/docs/api/safeds/ml/nn/converters/OutputConversion.md index 62ed9f47e..9227433d6 100644 --- a/docs/api/safeds/ml/nn/converters/OutputConversion.md +++ b/docs/api/safeds/ml/nn/converters/OutputConversion.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# :test_tube:{ title="Experimental" } `#!sds abstract class` `OutputConversion` {#safeds.ml.nn.converters.OutputConversion data-toc-label='[abstract class] OutputConversion'} +# :test_tube:{ title="Experimental" } `OutputConversion` {#safeds.ml.nn.converters.OutputConversion data-toc-label='[class] OutputConversion'} The output conversion for a neural network, defines the output parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/converters/OutputConversionImageToColumn.md b/docs/api/safeds/ml/nn/converters/OutputConversionImageToColumn.md index cd1e190f5..591fc8eb4 100644 --- a/docs/api/safeds/ml/nn/converters/OutputConversionImageToColumn.md +++ b/docs/api/safeds/ml/nn/converters/OutputConversionImageToColumn.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `OutputConversionImageToColumn` {#safeds.ml.nn.converters.OutputConversionImageToColumn data-toc-label='[class] OutputConversionImageToColumn'} +# :test_tube:{ title="Experimental" } `OutputConversionImageToColumn` {#safeds.ml.nn.converters.OutputConversionImageToColumn data-toc-label='[class] OutputConversionImageToColumn'} **Parent type:** [`OutputConversion>`][safeds.ml.nn.converters.OutputConversion] diff --git a/docs/api/safeds/ml/nn/converters/OutputConversionImageToImage.md b/docs/api/safeds/ml/nn/converters/OutputConversionImageToImage.md index 70efa7e88..283b0d74e 100644 --- a/docs/api/safeds/ml/nn/converters/OutputConversionImageToImage.md +++ b/docs/api/safeds/ml/nn/converters/OutputConversionImageToImage.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `OutputConversionImageToImage` {#safeds.ml.nn.converters.OutputConversionImageToImage data-toc-label='[class] OutputConversionImageToImage'} +# :test_tube:{ title="Experimental" } `OutputConversionImageToImage` {#safeds.ml.nn.converters.OutputConversionImageToImage data-toc-label='[class] OutputConversionImageToImage'} **Parent type:** [`OutputConversion`][safeds.ml.nn.converters.OutputConversion] diff --git a/docs/api/safeds/ml/nn/converters/OutputConversionImageToTable.md b/docs/api/safeds/ml/nn/converters/OutputConversionImageToTable.md index 773d50013..38b85f0f8 100644 --- a/docs/api/safeds/ml/nn/converters/OutputConversionImageToTable.md +++ b/docs/api/safeds/ml/nn/converters/OutputConversionImageToTable.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `OutputConversionImageToTable` {#safeds.ml.nn.converters.OutputConversionImageToTable data-toc-label='[class] OutputConversionImageToTable'} +# :test_tube:{ title="Experimental" } `OutputConversionImageToTable` {#safeds.ml.nn.converters.OutputConversionImageToTable data-toc-label='[class] OutputConversionImageToTable'} **Parent type:** [`OutputConversion`][safeds.ml.nn.converters.OutputConversion] diff --git a/docs/api/safeds/ml/nn/converters/OutputConversionTable.md b/docs/api/safeds/ml/nn/converters/OutputConversionTable.md index 5b70c43a8..66b277fa6 100644 --- a/docs/api/safeds/ml/nn/converters/OutputConversionTable.md +++ b/docs/api/safeds/ml/nn/converters/OutputConversionTable.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `OutputConversionTable` {#safeds.ml.nn.converters.OutputConversionTable data-toc-label='[class] OutputConversionTable'} +# :test_tube:{ title="Experimental" } `OutputConversionTable` {#safeds.ml.nn.converters.OutputConversionTable data-toc-label='[class] OutputConversionTable'} The output conversion for a neural network defines the output parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/converters/OutputConversionTimeSeries.md b/docs/api/safeds/ml/nn/converters/OutputConversionTimeSeries.md index 9a144d969..4a9374058 100644 --- a/docs/api/safeds/ml/nn/converters/OutputConversionTimeSeries.md +++ b/docs/api/safeds/ml/nn/converters/OutputConversionTimeSeries.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `OutputConversionTimeSeries` {#safeds.ml.nn.converters.OutputConversionTimeSeries data-toc-label='[class] OutputConversionTimeSeries'} +# :test_tube:{ title="Experimental" } `OutputConversionTimeSeries` {#safeds.ml.nn.converters.OutputConversionTimeSeries data-toc-label='[class] OutputConversionTimeSeries'} The output conversion for a neural network, defines the output parameters for the neural network. diff --git a/docs/api/safeds/ml/nn/layers/AveragePooling2DLayer.md b/docs/api/safeds/ml/nn/layers/AveragePooling2DLayer.md index b7b8d79aa..1a60cb1d4 100644 --- a/docs/api/safeds/ml/nn/layers/AveragePooling2DLayer.md +++ b/docs/api/safeds/ml/nn/layers/AveragePooling2DLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `AveragePooling2DLayer` {#safeds.ml.nn.layers.AveragePooling2DLayer data-toc-label='[class] AveragePooling2DLayer'} +# :test_tube:{ title="Experimental" } `AveragePooling2DLayer` {#safeds.ml.nn.layers.AveragePooling2DLayer data-toc-label='[class] AveragePooling2DLayer'} **Parent type:** [`Layer`][safeds.ml.nn.layers.Layer] @@ -29,13 +29,13 @@ } ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.AveragePooling2DLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.AveragePooling2DLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.AveragePooling2DLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.AveragePooling2DLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/api/safeds/ml/nn/layers/Convolutional2DLayer.md b/docs/api/safeds/ml/nn/layers/Convolutional2DLayer.md index eb9ed48bf..376391e2b 100644 --- a/docs/api/safeds/ml/nn/layers/Convolutional2DLayer.md +++ b/docs/api/safeds/ml/nn/layers/Convolutional2DLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `Convolutional2DLayer` {#safeds.ml.nn.layers.Convolutional2DLayer data-toc-label='[class] Convolutional2DLayer'} +# :test_tube:{ title="Experimental" } `Convolutional2DLayer` {#safeds.ml.nn.layers.Convolutional2DLayer data-toc-label='[class] Convolutional2DLayer'} **Parent type:** [`Layer`][safeds.ml.nn.layers.Layer] @@ -35,13 +35,13 @@ } ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.Convolutional2DLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.Convolutional2DLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.Convolutional2DLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.Convolutional2DLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/api/safeds/ml/nn/layers/ConvolutionalTranspose2DLayer.md b/docs/api/safeds/ml/nn/layers/ConvolutionalTranspose2DLayer.md index 15a4edd1f..57d89cc46 100644 --- a/docs/api/safeds/ml/nn/layers/ConvolutionalTranspose2DLayer.md +++ b/docs/api/safeds/ml/nn/layers/ConvolutionalTranspose2DLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `ConvolutionalTranspose2DLayer` {#safeds.ml.nn.layers.ConvolutionalTranspose2DLayer data-toc-label='[class] ConvolutionalTranspose2DLayer'} +# :test_tube:{ title="Experimental" } `ConvolutionalTranspose2DLayer` {#safeds.ml.nn.layers.ConvolutionalTranspose2DLayer data-toc-label='[class] ConvolutionalTranspose2DLayer'} **Parent type:** [`Convolutional2DLayer`][safeds.ml.nn.layers.Convolutional2DLayer] @@ -24,13 +24,13 @@ ) sub Convolutional2DLayer ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.ConvolutionalTranspose2DLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.ConvolutionalTranspose2DLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.ConvolutionalTranspose2DLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.ConvolutionalTranspose2DLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/api/safeds/ml/nn/layers/FlattenLayer.md b/docs/api/safeds/ml/nn/layers/FlattenLayer.md index cbdf11ff6..1ba7deb73 100644 --- a/docs/api/safeds/ml/nn/layers/FlattenLayer.md +++ b/docs/api/safeds/ml/nn/layers/FlattenLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `FlattenLayer` {#safeds.ml.nn.layers.FlattenLayer data-toc-label='[class] FlattenLayer'} +# :test_tube:{ title="Experimental" } `FlattenLayer` {#safeds.ml.nn.layers.FlattenLayer data-toc-label='[class] FlattenLayer'} **Parent type:** [`Layer`][safeds.ml.nn.layers.Layer] @@ -17,13 +17,13 @@ } ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.FlattenLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.FlattenLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.FlattenLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.FlattenLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/api/safeds/ml/nn/layers/ForwardLayer.md b/docs/api/safeds/ml/nn/layers/ForwardLayer.md index fd714b5ae..aca87c32e 100644 --- a/docs/api/safeds/ml/nn/layers/ForwardLayer.md +++ b/docs/api/safeds/ml/nn/layers/ForwardLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `ForwardLayer` {#safeds.ml.nn.layers.ForwardLayer data-toc-label='[class] ForwardLayer'} +# :test_tube:{ title="Experimental" } `ForwardLayer` {#safeds.ml.nn.layers.ForwardLayer data-toc-label='[class] ForwardLayer'} **Parent type:** [`Layer`][safeds.ml.nn.layers.Layer] @@ -27,13 +27,13 @@ } ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.ForwardLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.ForwardLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.ForwardLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.ForwardLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/api/safeds/ml/nn/layers/LSTMLayer.md b/docs/api/safeds/ml/nn/layers/LSTMLayer.md index 845c61d6b..33abe035c 100644 --- a/docs/api/safeds/ml/nn/layers/LSTMLayer.md +++ b/docs/api/safeds/ml/nn/layers/LSTMLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `LSTMLayer` {#safeds.ml.nn.layers.LSTMLayer data-toc-label='[class] LSTMLayer'} +# :test_tube:{ title="Experimental" } `LSTMLayer` {#safeds.ml.nn.layers.LSTMLayer data-toc-label='[class] LSTMLayer'} **Parent type:** [`Layer`][safeds.ml.nn.layers.Layer] @@ -27,13 +27,13 @@ } ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.LSTMLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.LSTMLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`Int`][safeds.lang.Int] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.LSTMLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.LSTMLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/api/safeds/ml/nn/layers/Layer.md b/docs/api/safeds/ml/nn/layers/Layer.md index 4d1849dfe..d15c981f4 100644 --- a/docs/api/safeds/ml/nn/layers/Layer.md +++ b/docs/api/safeds/ml/nn/layers/Layer.md @@ -3,7 +3,7 @@ search: boost: 0.5 --- -# :test_tube:{ title="Experimental" } `#!sds abstract class` `Layer` {#safeds.ml.nn.layers.Layer data-toc-label='[abstract class] Layer'} +# :test_tube:{ title="Experimental" } `Layer` {#safeds.ml.nn.layers.Layer data-toc-label='[class] Layer'} **Inheritors:** diff --git a/docs/api/safeds/ml/nn/layers/MaxPooling2DLayer.md b/docs/api/safeds/ml/nn/layers/MaxPooling2DLayer.md index de8e40736..2a1427051 100644 --- a/docs/api/safeds/ml/nn/layers/MaxPooling2DLayer.md +++ b/docs/api/safeds/ml/nn/layers/MaxPooling2DLayer.md @@ -1,4 +1,4 @@ -# :test_tube:{ title="Experimental" } `#!sds class` `MaxPooling2DLayer` {#safeds.ml.nn.layers.MaxPooling2DLayer data-toc-label='[class] MaxPooling2DLayer'} +# :test_tube:{ title="Experimental" } `MaxPooling2DLayer` {#safeds.ml.nn.layers.MaxPooling2DLayer data-toc-label='[class] MaxPooling2DLayer'} **Parent type:** [`Layer`][safeds.ml.nn.layers.Layer] @@ -29,13 +29,13 @@ } ``` -## `#!sds attr` `inputSize` {#safeds.ml.nn.layers.MaxPooling2DLayer.inputSize data-toc-label='[attr] inputSize'} +## `inputSize` {#safeds.ml.nn.layers.MaxPooling2DLayer.inputSize data-toc-label='[attribute] inputSize'} Get the input_size of this layer. **Type:** [`ImageSize`][safeds.data.image.typing.ImageSize] -## `#!sds attr` `outputSize` {#safeds.ml.nn.layers.MaxPooling2DLayer.outputSize data-toc-label='[attr] outputSize'} +## `outputSize` {#safeds.ml.nn.layers.MaxPooling2DLayer.outputSize data-toc-label='[attribute] outputSize'} Get the output_size of this layer. diff --git a/docs/src/overrides/partials/toc-item.html b/docs/src/overrides/partials/toc-item.html index d71086926..da0396269 100644 --- a/docs/src/overrides/partials/toc-item.html +++ b/docs/src/overrides/partials/toc-item.html @@ -2,18 +2,20 @@
  • - {% if toc_item.title.startswith("[attr] ") %} -  {{ toc_item.title | replace("[attr] ", "") }} - {% elif toc_item.title.startswith("[static attr] ") %} -  {{ toc_item.title | replace("[static attr] ", "") }} + {% if toc_item.title.startswith("[attribute] ") %} +  {{ toc_item.title | replace("[attribute] ", "") }} + {% elif toc_item.title.startswith("[static-attribute] ") %} +  {{ toc_item.title | replace("[static-attribute] ", "") }} {% elif toc_item.title.startswith("[class] ") %}  {{ toc_item.title | replace("[class] ", "") }} {% elif toc_item.title.startswith("[enum] ") %}  {{ toc_item.title | replace("[enum] ", "") }} - {% elif toc_item.title.startswith("[fun] ") %} -  {{ toc_item.title | replace("[fun] ", "") }} - {% elif toc_item.title.startswith("[static fun] ") %} -  {{ toc_item.title | replace("[static fun] ", "") }} + {% elif toc_item.title.startswith("[variant] ") %} +  {{ toc_item.title | replace("[variant] ", "") }} + {% elif toc_item.title.startswith("[function] ") %} +  {{ toc_item.title | replace("[function] ", "") }} + {% elif toc_item.title.startswith("[static-function] ") %} +  {{ toc_item.title | replace("[static-function] ", "") }} {% else %} {{ toc_item.title }} {% endif %} diff --git a/docs/src/stylesheets/extra.css b/docs/src/stylesheets/extra.css index d752ab06d..8b461de96 100644 --- a/docs/src/stylesheets/extra.css +++ b/docs/src/stylesheets/extra.css @@ -14,27 +14,43 @@ :root, [data-md-color-scheme="default"] { + --doc-symbol-annotation-fg-color: #95002d; --doc-symbol-attribute-fg-color: #953800; --doc-symbol-class-fg-color: #0550ae; --doc-symbol-enum-fg-color: #5cad0f; + --doc-symbol-variant-fg-color: #5cad0f; --doc-symbol-function-fg-color: #8250df; + --doc-symbol-segment-fg-color: #8250df; + --doc-symbol-schema-fg-color: #3ead9d; + --doc-symbol-annotation-bg-color: #95002d1a; --doc-symbol-attribute-bg-color: #9538001a; --doc-symbol-class-bg-color: #0550ae1a; --doc-symbol-enum-bg-color: #5cad0f1a; + --doc-symbol-variant-bg-color: #5cad0f1a; --doc-symbol-function-bg-color: #8250df1a; + --doc-symbol-segment-bg-color: #8250df1a; + --doc-symbol-schema-bg-color: #3ead9d1a; } [data-md-color-scheme="slate"] { + --doc-symbol-annotation-fg-color: #ff004d; --doc-symbol-attribute-fg-color: #ffa657; --doc-symbol-class-fg-color: #79c0ff; --doc-symbol-enum-fg-color: #baff79; + --doc-symbol-variant-fg-color: #baff79; --doc-symbol-function-fg-color: #d2a8ff; + --doc-symbol-segment-fg-color: #d2a8ff; + --doc-symbol-schema-fg-color: #5cffe7; + --doc-symbol-annotation-bg-color: #ff004d1a; --doc-symbol-attribute-bg-color: #ffa6571a; --doc-symbol-class-bg-color: #79c0ff1a; --doc-symbol-enum-bg-color: #baff791a; + --doc-symbol-variant-bg-color: #baff791a; --doc-symbol-function-bg-color: #d2a8ff1a; + --doc-symbol-segment-bg-color: #d2a8ff1a; + --doc-symbol-schema-bg-color: #5cffe71a; } code.doc-symbol { @@ -44,6 +60,15 @@ code.doc-symbol { font-weight: bold; } +code.doc-symbol-annotation { + color: var(--doc-symbol-annotation-fg-color); + background-color: var(--doc-symbol-annotation-bg-color); +} + +code.doc-symbol-annotation::after { + content: "annotation"; +} + code.doc-symbol-attribute, code.doc-symbol-static-attribute { color: var(--doc-symbol-attribute-fg-color); @@ -55,7 +80,7 @@ code.doc-symbol-attribute::after { } code.doc-symbol-static-attribute::after { - content: "static attr"; + content: "static\00a0 attr"; } code.doc-symbol-class { @@ -76,6 +101,15 @@ code.doc-symbol-enum::after { content: "enum"; } +code.doc-symbol-variant { + color: var(--doc-symbol-variant-fg-color); + background-color: var(--doc-symbol-variant-bg-color); +} + +code.doc-symbol-variant::after { + content: "variant"; +} + code.doc-symbol-function, code.doc-symbol-static-function { color: var(--doc-symbol-function-fg-color); @@ -87,5 +121,23 @@ code.doc-symbol-function::after { } code.doc-symbol-static-function::after { - content: "static fun"; + content: "static\00a0 fun"; +} + +code.doc-symbol-segment { + color: var(--doc-symbol-segment-fg-color); + background-color: var(--doc-symbol-segment-bg-color); +} + +code.doc-symbol-segment::after { + content: "segment"; +} + +code.doc-symbol-schema { + color: var(--doc-symbol-schema-fg-color); + background-color: var(--doc-symbol-schema-bg-color); +} + +code.doc-symbol-schema::after { + content: "schema"; } diff --git a/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts b/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts index 5dce647c3..8082a906c 100644 --- a/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts +++ b/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts @@ -38,7 +38,6 @@ import { getQualifiedName, getResults, getTypeParameters, - isInternal, isPrivate, isStatic, } from '../helpers/nodeProperties.js'; @@ -205,8 +204,8 @@ export class SafeDsMarkdownGenerator { } private describeAttribute(node: SdsAttribute, state: DetailsState): string { - const keyword = isStatic(node) ? 'static attr' : 'attr'; - let result = this.renderPreamble(node, state, 'attribute', keyword); + const tag = isStatic(node) ? 'static-attribute' : 'attribute'; + let result = this.renderPreamble(node, state, tag); // Type const type = this.typeComputer.computeType(node.type); @@ -222,8 +221,7 @@ export class SafeDsMarkdownGenerator { } private describeClass(node: SdsClass, state: DetailsState): string { - const keyword = node.parameterList ? 'class' : 'abstract class'; - let result = this.renderPreamble(node, state, 'class', keyword); + let result = this.renderPreamble(node, state, 'class'); // Parent type const parentTypes = getParentTypes(node); @@ -375,7 +373,7 @@ export class SafeDsMarkdownGenerator { } private describeEnumVariant(node: SdsEnumVariant, state: DetailsState): string { - let result = this.renderPreamble(node, state, 'enum variant', ''); + let result = this.renderPreamble(node, state, 'variant'); // Parameters const parameters = this.renderParameters(getParameters(node), state.knownPaths); @@ -393,8 +391,8 @@ export class SafeDsMarkdownGenerator { } private describeFunction(node: SdsFunction, state: DetailsState): string { - const keyword = isStatic(node) ? 'static fun' : 'fun'; - let result = this.renderPreamble(node, state, 'function', keyword); + const tag = isStatic(node) ? 'static-function' : 'function'; + let result = this.renderPreamble(node, state, tag); // Parameters const parameters = this.renderParameters(getParameters(node), state.knownPaths); @@ -463,8 +461,7 @@ export class SafeDsMarkdownGenerator { } private describeSegment(node: SdsSegment, state: DetailsState): string { - const keyword = isInternal(node) ? 'internal segment' : 'segment'; - let result = this.renderPreamble(node, state, 'segment', keyword); + let result = this.renderPreamble(node, state, 'segment'); // Parameters const parameters = this.renderParameters(getParameters(node), state.knownPaths); @@ -493,12 +490,12 @@ export class SafeDsMarkdownGenerator { return result; } - private renderPreamble(node: SdsDeclaration, state: DetailsState, kind: string, keyword: string = kind): string { + private renderPreamble(node: SdsDeclaration, state: DetailsState, tag?: Tag): string { let result = this.renderFrontMatter(node); - result += this.renderHeading(node, state, keyword) + '\n'; + result += this.renderHeading(node, state, tag) + '\n'; - const deprecationWarning = this.renderDeprecationWarning(node, kind); + const deprecationWarning = this.renderDeprecationWarning(node); if (deprecationWarning) { result += `\n${deprecationWarning}\n`; } @@ -518,22 +515,22 @@ export class SafeDsMarkdownGenerator { return ''; } - private renderHeading(node: SdsDeclaration, state: DetailsState, keyword: string): string { + private renderHeading(node: SdsDeclaration, state: DetailsState, tag?: Tag): string { let result = '#'.repeat(Math.min(state.level, 6)); result += this.renderMaturity(node); - if (keyword) { - result += ` \`#!sds ${keyword}\``; + if (tag) { + result += ` `; } result += ` \`${node.name}\``; - result += ` {#${this.getId(node, state)} data-toc-label='${this.createTocLabel(node, keyword)}'}`; + result += ` {#${this.getId(node, state)} data-toc-label='${this.createTocLabel(node, tag)}'}`; return result; } - private createTocLabel(node: SdsDeclaration, keyword: string): string { - if (keyword) { - return `[${keyword}] ${node.name}`; + private createTocLabel(node: SdsDeclaration, tag?: Tag): string { + if (tag) { + return `[${tag}] ${node.name}`; } else { return node.name; } @@ -557,14 +554,14 @@ export class SafeDsMarkdownGenerator { } } - private renderDeprecationWarning(node: SdsDeclaration, keyword: string): string { + private renderDeprecationWarning(node: SdsDeclaration): string { const deprecationInfo = this.builtinAnnotations.getDeprecationInfo(node); if (!deprecationInfo) { return ''; } let result = '!!! warning "Deprecated"\n\n'; - result += ` This ${keyword} is deprecated`; + result += ` This declaration is deprecated`; if (deprecationInfo.sinceVersion) { result += ` since version **${deprecationInfo.sinceVersion}**`; @@ -839,3 +836,15 @@ interface Summary { const indent = (text: string): string => { return addLinePrefix(text, INDENTATION); }; + +type Tag = + | 'annotation' + | 'attribute' + | 'static-attribute' + | 'class' + | 'enum' + | 'function' + | 'static-function' + | 'schema' + | 'segment' + | 'variant';