Package com.oracle.bmc.aivision.model

Class Model.Builder

  • Enclosing class:
    Model
    public static class Model.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Model.Builder id​(String id)
        A unique identifier that is immutable after creation.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public Model.Builder displayName​(String displayName)
        A human-friendly name for the model, which can be changed.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • description

        public Model.Builder description​(String description)
        An optional description of the model.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public Model.Builder compartmentId​(String compartmentId)
        The compartment identifier.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • modelType

        public Model.Builder modelType​(Model.ModelType modelType)
        What type of Vision model this is.
        Parameters:
        modelType - the value to set
        Returns:
        this builder

      • isQuickMode

        public Model.Builder isQuickMode​(Boolean isQuickMode)
        Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.
        Parameters:
        isQuickMode - the value to set
        Returns:
        this builder

      • maxTrainingDurationInHours

        public Model.Builder maxTrainingDurationInHours​(Double maxTrainingDurationInHours)
        The maximum model training duration in hours, expressed as a decimal fraction.
        Parameters:
        maxTrainingDurationInHours - the value to set
        Returns:
        this builder

      • trainedDurationInHours

        public Model.Builder trainedDurationInHours​(Double trainedDurationInHours)
        The total hours actually used for model training.
        Parameters:
        trainedDurationInHours - the value to set
        Returns:
        this builder

      • modelVersion

        public Model.Builder modelVersion​(String modelVersion)
        The version of the model.
        Parameters:
        modelVersion - the value to set
        Returns:
        this builder

      • projectId

        public Model.Builder projectId​(String projectId)
        The OCID of the project that contains the model.
        Parameters:
        projectId - the value to set
        Returns:
        this builder

      • timeCreated

        public Model.Builder timeCreated​(Date timeCreated)
        When the model was created, as an RFC3339 datetime string.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public Model.Builder timeUpdated​(Date timeUpdated)
        When the model was updated, as an RFC3339 datetime string.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • lifecycleState

        public Model.Builder lifecycleState​(Model.LifecycleState lifecycleState)
        The current state of the model.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Model.Builder lifecycleDetails​(String lifecycleDetails)
        A message describing the current state in more detail, that can provide actionable information if training failed.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • precision

        public Model.Builder precision​(Float precision)
        The precision of the trained model.
        Parameters:
        precision - the value to set
        Returns:
        this builder

      • recall

        public Model.Builder recall​(Float recall)
        Recall of the trained model.
        Parameters:
        recall - the value to set
        Returns:
        this builder

      • averagePrecision

        public Model.Builder averagePrecision​(Float averagePrecision)
        The mean average precision of the trained model.
        Parameters:
        averagePrecision - the value to set
        Returns:
        this builder

      • confidenceThreshold

        public Model.Builder confidenceThreshold​(Float confidenceThreshold)
        The intersection over the union threshold used for calculating precision and recall.
        Parameters:
        confidenceThreshold - the value to set
        Returns:
        this builder

      • totalImageCount

        public Model.Builder totalImageCount​(Integer totalImageCount)
        The number of images in the dataset used to train, validate, and test the model.
        Parameters:
        totalImageCount - the value to set
        Returns:
        this builder

      • testImageCount

        public Model.Builder testImageCount​(Integer testImageCount)
        The number of images set aside for evaluating model performance metrics after training.
        Parameters:
        testImageCount - the value to set
        Returns:
        this builder

      • metrics

        public Model.Builder metrics​(String metrics)
        The complete set of per-label metrics for successfully trained models.
        Parameters:
        metrics - the value to set
        Returns:
        this builder

      • freeformTags

        public Model.Builder freeformTags​(Map<String,​String> freeformTags)
        A simple key-value pair that is applied without any predefined name, type, or scope.

        It exists for cross-compatibility only. For example: {“bar-key”: “value”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public Model.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public Model.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. For example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • build

        public Model build()