com.pulumi.azurenative.machinelearningservices.kotlin.inputs.ImageObjectDetectionArgs.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azurenative.machinelearningservices.kotlin.inputs

import com.pulumi.azurenative.machinelearningservices.inputs.ImageObjectDetectionArgs.builder
import com.pulumi.azurenative.machinelearningservices.kotlin.enums.LogVerbosity
import com.pulumi.azurenative.machinelearningservices.kotlin.enums.ObjectDetectionPrimaryMetrics
import com.pulumi.core.Either
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Double
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * Image Object Detection. Object detection is used to identify objects in an image and locate each object with a
 * bounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.
 * @property limitSettings [Required] Limit settings for the AutoML job.
 * @property logVerbosity Log verbosity for the job.
 * @property modelSettings Settings used for training the model.
 * @property primaryMetric Primary metric to optimize for this task.
 * @property searchSpace Search space for sampling different combinations of models and their hyperparameters.
 * @property sweepSettings Model sweeping and hyperparameter sweeping related settings.
 * @property targetColumnName Target column name: This is prediction values column.
 * Also known as label column name in context of classification tasks.
 * @property taskType AutoMLJob Task type.
 * Expected value is 'ImageObjectDetection'.
 * @property trainingData [Required] Training data input.
 * @property validationData Validation data inputs.
 * @property validationDataSize The fraction of training dataset that needs to be set aside for validation purpose.
 * Values between (0.0 , 1.0)
 * Applied when validation dataset is not provided.
 */
public data class ImageObjectDetectionArgs(
    public val limitSettings: Output,
    public val logVerbosity: Output>? = null,
    public val modelSettings: Output? = null,
    public val primaryMetric: Output>? = null,
    public val searchSpace: Output>? = null,
    public val sweepSettings: Output? = null,
    public val targetColumnName: Output? = null,
    public val taskType: Output,
    public val trainingData: Output,
    public val validationData: Output? = null,
    public val validationDataSize: Output? = null,
) :
    ConvertibleToJava {
    override fun toJava(): com.pulumi.azurenative.machinelearningservices.inputs.ImageObjectDetectionArgs =
        com.pulumi.azurenative.machinelearningservices.inputs.ImageObjectDetectionArgs.builder()
            .limitSettings(limitSettings.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .logVerbosity(
                logVerbosity?.applyValue({ args0 ->
                    args0.transform({ args0 -> args0 }, { args0 ->
                        args0.let({ args0 -> args0.toJava() })
                    })
                }),
            )
            .modelSettings(modelSettings?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .primaryMetric(
                primaryMetric?.applyValue({ args0 ->
                    args0.transform({ args0 -> args0 }, { args0 ->
                        args0.let({ args0 -> args0.toJava() })
                    })
                }),
            )
            .searchSpace(
                searchSpace?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.let({ args0 ->
                            args0.toJava()
                        })
                    })
                }),
            )
            .sweepSettings(sweepSettings?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .targetColumnName(targetColumnName?.applyValue({ args0 -> args0 }))
            .taskType(taskType.applyValue({ args0 -> args0 }))
            .trainingData(trainingData.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .validationData(validationData?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .validationDataSize(validationDataSize?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ImageObjectDetectionArgs].
 */
@PulumiTagMarker
public class ImageObjectDetectionArgsBuilder internal constructor() {
    private var limitSettings: Output? = null

    private var logVerbosity: Output>? = null

    private var modelSettings: Output? = null

    private var primaryMetric: Output>? = null

    private var searchSpace: Output>? = null

    private var sweepSettings: Output? = null

    private var targetColumnName: Output? = null

    private var taskType: Output? = null

    private var trainingData: Output? = null

    private var validationData: Output? = null

    private var validationDataSize: Output? = null

    /**
     * @param value [Required] Limit settings for the AutoML job.
     */
    @JvmName("ficoldhporojbitm")
    public suspend fun limitSettings(`value`: Output) {
        this.limitSettings = value
    }

    /**
     * @param value Log verbosity for the job.
     */
    @JvmName("pctfvrgbkoeyvugu")
    public suspend fun logVerbosity(`value`: Output>) {
        this.logVerbosity = value
    }

    /**
     * @param value Settings used for training the model.
     */
    @JvmName("pugnahodswegqwsj")
    public suspend fun modelSettings(`value`: Output) {
        this.modelSettings = value
    }

    /**
     * @param value Primary metric to optimize for this task.
     */
    @JvmName("kctyjqffcfbmsrey")
    public suspend fun primaryMetric(`value`: Output>) {
        this.primaryMetric = value
    }

    /**
     * @param value Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("guwtiswknrwaxxic")
    public suspend fun searchSpace(`value`: Output>) {
        this.searchSpace = value
    }

    @JvmName("qvlobwcqkqbxdftb")
    public suspend fun searchSpace(vararg values: Output) {
        this.searchSpace = Output.all(values.asList())
    }

    /**
     * @param values Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("cvyxwfogevrlhukc")
    public suspend fun searchSpace(values: List>) {
        this.searchSpace = Output.all(values)
    }

    /**
     * @param value Model sweeping and hyperparameter sweeping related settings.
     */
    @JvmName("pnxgyhiugdmctbwc")
    public suspend fun sweepSettings(`value`: Output) {
        this.sweepSettings = value
    }

    /**
     * @param value Target column name: This is prediction values column.
     * Also known as label column name in context of classification tasks.
     */
    @JvmName("lyijetjcbbqwknar")
    public suspend fun targetColumnName(`value`: Output) {
        this.targetColumnName = value
    }

    /**
     * @param value AutoMLJob Task type.
     * Expected value is 'ImageObjectDetection'.
     */
    @JvmName("hgprshjwbrguojyv")
    public suspend fun taskType(`value`: Output) {
        this.taskType = value
    }

    /**
     * @param value [Required] Training data input.
     */
    @JvmName("mlqasuroljdgrtbm")
    public suspend fun trainingData(`value`: Output) {
        this.trainingData = value
    }

    /**
     * @param value Validation data inputs.
     */
    @JvmName("itksjxnulngcofqe")
    public suspend fun validationData(`value`: Output) {
        this.validationData = value
    }

    /**
     * @param value The fraction of training dataset that needs to be set aside for validation purpose.
     * Values between (0.0 , 1.0)
     * Applied when validation dataset is not provided.
     */
    @JvmName("twoajgkasceqjeek")
    public suspend fun validationDataSize(`value`: Output) {
        this.validationDataSize = value
    }

    /**
     * @param value [Required] Limit settings for the AutoML job.
     */
    @JvmName("xtxlybfkkuxfdweg")
    public suspend fun limitSettings(`value`: ImageLimitSettingsArgs) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.limitSettings = mapped
    }

    /**
     * @param argument [Required] Limit settings for the AutoML job.
     */
    @JvmName("bumnwtpxlnqabvqt")
    public suspend fun limitSettings(argument: suspend ImageLimitSettingsArgsBuilder.() -> Unit) {
        val toBeMapped = ImageLimitSettingsArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.limitSettings = mapped
    }

    /**
     * @param value Log verbosity for the job.
     */
    @JvmName("thtoskyhpgufnbom")
    public suspend fun logVerbosity(`value`: Either?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.logVerbosity = mapped
    }

    /**
     * @param value Log verbosity for the job.
     */
    @JvmName("xrfbxdpqaovqovwq")
    public fun logVerbosity(`value`: String) {
        val toBeMapped = Either.ofLeft(value)
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.logVerbosity = mapped
    }

    /**
     * @param value Log verbosity for the job.
     */
    @JvmName("swxeftlfcnuxhdwb")
    public fun logVerbosity(`value`: LogVerbosity) {
        val toBeMapped = Either.ofRight(value)
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.logVerbosity = mapped
    }

    /**
     * @param value Settings used for training the model.
     */
    @JvmName("dxcjgxejlqqsewds")
    public suspend fun modelSettings(`value`: ImageModelSettingsObjectDetectionArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.modelSettings = mapped
    }

    /**
     * @param argument Settings used for training the model.
     */
    @JvmName("mwfjgdsbkqaeeuve")
    public suspend fun modelSettings(argument: suspend ImageModelSettingsObjectDetectionArgsBuilder.() -> Unit) {
        val toBeMapped = ImageModelSettingsObjectDetectionArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.modelSettings = mapped
    }

    /**
     * @param value Primary metric to optimize for this task.
     */
    @JvmName("mnfxoywrlhvnlekp")
    public suspend fun primaryMetric(`value`: Either?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.primaryMetric = mapped
    }

    /**
     * @param value Primary metric to optimize for this task.
     */
    @JvmName("rkdnkkumpchhjabq")
    public fun primaryMetric(`value`: String) {
        val toBeMapped = Either.ofLeft(value)
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.primaryMetric = mapped
    }

    /**
     * @param value Primary metric to optimize for this task.
     */
    @JvmName("agvmtvxersslorix")
    public fun primaryMetric(`value`: ObjectDetectionPrimaryMetrics) {
        val toBeMapped = Either.ofRight(value)
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.primaryMetric = mapped
    }

    /**
     * @param value Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("tbsowpjnwlxofcfe")
    public suspend fun searchSpace(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.searchSpace = mapped
    }

    /**
     * @param argument Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("hssycmphgknliauu")
    public suspend fun searchSpace(argument: List Unit>) {
        val toBeMapped = argument.toList().map {
            ImageModelDistributionSettingsObjectDetectionArgsBuilder().applySuspend { it() }.build()
        }
        val mapped = of(toBeMapped)
        this.searchSpace = mapped
    }

    /**
     * @param argument Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("srbjcpdyiixankkk")
    public suspend fun searchSpace(vararg argument: suspend ImageModelDistributionSettingsObjectDetectionArgsBuilder.() -> Unit) {
        val toBeMapped = argument.toList().map {
            ImageModelDistributionSettingsObjectDetectionArgsBuilder().applySuspend { it() }.build()
        }
        val mapped = of(toBeMapped)
        this.searchSpace = mapped
    }

    /**
     * @param argument Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("ueckkcwboenpxtky")
    public suspend fun searchSpace(argument: suspend ImageModelDistributionSettingsObjectDetectionArgsBuilder.() -> Unit) {
        val toBeMapped = listOf(
            ImageModelDistributionSettingsObjectDetectionArgsBuilder().applySuspend
                { argument() }.build(),
        )
        val mapped = of(toBeMapped)
        this.searchSpace = mapped
    }

    /**
     * @param values Search space for sampling different combinations of models and their hyperparameters.
     */
    @JvmName("dmdhmdgcdteoyvok")
    public suspend fun searchSpace(vararg values: ImageModelDistributionSettingsObjectDetectionArgs) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.searchSpace = mapped
    }

    /**
     * @param value Model sweeping and hyperparameter sweeping related settings.
     */
    @JvmName("lefbbvwnynihdlwq")
    public suspend fun sweepSettings(`value`: ImageSweepSettingsArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.sweepSettings = mapped
    }

    /**
     * @param argument Model sweeping and hyperparameter sweeping related settings.
     */
    @JvmName("knvqwadfmiohpmmc")
    public suspend fun sweepSettings(argument: suspend ImageSweepSettingsArgsBuilder.() -> Unit) {
        val toBeMapped = ImageSweepSettingsArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.sweepSettings = mapped
    }

    /**
     * @param value Target column name: This is prediction values column.
     * Also known as label column name in context of classification tasks.
     */
    @JvmName("smxxvynlcmoelops")
    public suspend fun targetColumnName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.targetColumnName = mapped
    }

    /**
     * @param value AutoMLJob Task type.
     * Expected value is 'ImageObjectDetection'.
     */
    @JvmName("fvpchmlspahuchlv")
    public suspend fun taskType(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.taskType = mapped
    }

    /**
     * @param value [Required] Training data input.
     */
    @JvmName("hjbdfmgjqcotkabe")
    public suspend fun trainingData(`value`: MLTableJobInputArgs) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.trainingData = mapped
    }

    /**
     * @param argument [Required] Training data input.
     */
    @JvmName("bvlfxiqamoqueluh")
    public suspend fun trainingData(argument: suspend MLTableJobInputArgsBuilder.() -> Unit) {
        val toBeMapped = MLTableJobInputArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.trainingData = mapped
    }

    /**
     * @param value Validation data inputs.
     */
    @JvmName("sjirqokufejfmgxt")
    public suspend fun validationData(`value`: MLTableJobInputArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.validationData = mapped
    }

    /**
     * @param argument Validation data inputs.
     */
    @JvmName("aoeidvhthfwljxam")
    public suspend fun validationData(argument: suspend MLTableJobInputArgsBuilder.() -> Unit) {
        val toBeMapped = MLTableJobInputArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.validationData = mapped
    }

    /**
     * @param value The fraction of training dataset that needs to be set aside for validation purpose.
     * Values between (0.0 , 1.0)
     * Applied when validation dataset is not provided.
     */
    @JvmName("yjqnhpjroniqeath")
    public suspend fun validationDataSize(`value`: Double?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.validationDataSize = mapped
    }

    internal fun build(): ImageObjectDetectionArgs = ImageObjectDetectionArgs(
        limitSettings = limitSettings ?: throw PulumiNullFieldException("limitSettings"),
        logVerbosity = logVerbosity,
        modelSettings = modelSettings,
        primaryMetric = primaryMetric,
        searchSpace = searchSpace,
        sweepSettings = sweepSettings,
        targetColumnName = targetColumnName,
        taskType = taskType ?: throw PulumiNullFieldException("taskType"),
        trainingData = trainingData ?: throw PulumiNullFieldException("trainingData"),
        validationData = validationData,
        validationDataSize = validationDataSize,
    )
}