Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataScience
  5. ModelProvenance
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataScience.ModelProvenance

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Model Provenance resource in Oracle Cloud Infrastructure Data Science service.

    Creates provenance information for the specified model.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testModelProvenance = new oci.datascience.ModelProvenance("test_model_provenance", {
    modelId: testModel.id,
    gitBranch: modelProvenanceGitBranch,
    gitCommit: modelProvenanceGitCommit,
    repositoryUrl: modelProvenanceRepositoryUrl,
    scriptDir: modelProvenanceScriptDir,
    trainingId: testTraining.id,
    trainingScript: modelProvenanceTrainingScript,
});

    import pulumi
import pulumi_oci as oci

test_model_provenance = oci.data_science.ModelProvenance("test_model_provenance",
    model_id=test_model["id"],
    git_branch=model_provenance_git_branch,
    git_commit=model_provenance_git_commit,
    repository_url=model_provenance_repository_url,
    script_dir=model_provenance_script_dir,
    training_id=test_training["id"],
    training_script=model_provenance_training_script)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DataScience"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataScience.NewModelProvenance(ctx, "test_model_provenance", &DataScience.ModelProvenanceArgs{
			ModelId:        pulumi.Any(testModel.Id),
			GitBranch:      pulumi.Any(modelProvenanceGitBranch),
			GitCommit:      pulumi.Any(modelProvenanceGitCommit),
			RepositoryUrl:  pulumi.Any(modelProvenanceRepositoryUrl),
			ScriptDir:      pulumi.Any(modelProvenanceScriptDir),
			TrainingId:     pulumi.Any(testTraining.Id),
			TrainingScript: pulumi.Any(modelProvenanceTrainingScript),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testModelProvenance = new Oci.DataScience.ModelProvenance("test_model_provenance", new()
    {
        ModelId = testModel.Id,
        GitBranch = modelProvenanceGitBranch,
        GitCommit = modelProvenanceGitCommit,
        RepositoryUrl = modelProvenanceRepositoryUrl,
        ScriptDir = modelProvenanceScriptDir,
        TrainingId = testTraining.Id,
        TrainingScript = modelProvenanceTrainingScript,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataScience.ModelProvenance;
import com.pulumi.oci.DataScience.ModelProvenanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testModelProvenance = new ModelProvenance("testModelProvenance", ModelProvenanceArgs.builder()
            .modelId(testModel.id())
            .gitBranch(modelProvenanceGitBranch)
            .gitCommit(modelProvenanceGitCommit)
            .repositoryUrl(modelProvenanceRepositoryUrl)
            .scriptDir(modelProvenanceScriptDir)
            .trainingId(testTraining.id())
            .trainingScript(modelProvenanceTrainingScript)
            .build());

    }
}

    resources:
  testModelProvenance:
    type: oci:DataScience:ModelProvenance
    name: test_model_provenance
    properties:
      modelId: ${testModel.id}
      gitBranch: ${modelProvenanceGitBranch}
      gitCommit: ${modelProvenanceGitCommit}
      repositoryUrl: ${modelProvenanceRepositoryUrl}
      scriptDir: ${modelProvenanceScriptDir}
      trainingId: ${testTraining.id}
      trainingScript: ${modelProvenanceTrainingScript}

    Create ModelProvenance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ModelProvenance(name: string, args: ModelProvenanceArgs, opts?: CustomResourceOptions);
    @overload
def ModelProvenance(resource_name: str,
                    args: ModelProvenanceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ModelProvenance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    model_id: Optional[str] = None,
                    git_branch: Optional[str] = None,
                    git_commit: Optional[str] = None,
                    repository_url: Optional[str] = None,
                    script_dir: Optional[str] = None,
                    training_id: Optional[str] = None,
                    training_script: Optional[str] = None)
    func NewModelProvenance(ctx *Context, name string, args ModelProvenanceArgs, opts ...ResourceOption) (*ModelProvenance, error)
    public ModelProvenance(string name, ModelProvenanceArgs args, CustomResourceOptions? opts = null)
    public ModelProvenance(String name, ModelProvenanceArgs args)
public ModelProvenance(String name, ModelProvenanceArgs args, CustomResourceOptions options)

    type: oci:DataScience:ModelProvenance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ModelProvenanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ModelProvenanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ModelProvenanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ModelProvenanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ModelProvenanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var modelProvenanceResource = new Oci.DataScience.ModelProvenance("modelProvenanceResource", new()
{
    ModelId = "string",
    GitBranch = "string",
    GitCommit = "string",
    RepositoryUrl = "string",
    ScriptDir = "string",
    TrainingId = "string",
    TrainingScript = "string",
});

    example, err := DataScience.NewModelProvenance(ctx, "modelProvenanceResource", &DataScience.ModelProvenanceArgs{
	ModelId:        pulumi.String("string"),
	GitBranch:      pulumi.String("string"),
	GitCommit:      pulumi.String("string"),
	RepositoryUrl:  pulumi.String("string"),
	ScriptDir:      pulumi.String("string"),
	TrainingId:     pulumi.String("string"),
	TrainingScript: pulumi.String("string"),
})

    var modelProvenanceResource = new ModelProvenance("modelProvenanceResource", ModelProvenanceArgs.builder()
    .modelId("string")
    .gitBranch("string")
    .gitCommit("string")
    .repositoryUrl("string")
    .scriptDir("string")
    .trainingId("string")
    .trainingScript("string")
    .build());

    model_provenance_resource = oci.data_science.ModelProvenance("modelProvenanceResource",
    model_id="string",
    git_branch="string",
    git_commit="string",
    repository_url="string",
    script_dir="string",
    training_id="string",
    training_script="string")

    const modelProvenanceResource = new oci.datascience.ModelProvenance("modelProvenanceResource", {
    modelId: "string",
    gitBranch: "string",
    gitCommit: "string",
    repositoryUrl: "string",
    scriptDir: "string",
    trainingId: "string",
    trainingScript: "string",
});

    type: oci:DataScience:ModelProvenance
properties:
    gitBranch: string
    gitCommit: string
    modelId: string
    repositoryUrl: string
    scriptDir: string
    trainingId: string
    trainingScript: string

    ModelProvenance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ModelProvenance resource accepts the following input properties:

    ModelId string
    The OCID of the model.
    GitBranch string
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    GitCommit string
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    RepositoryUrl string
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    ScriptDir string
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    TrainingId string
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    TrainingScript string

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    ModelId string
    The OCID of the model.
    GitBranch string
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    GitCommit string
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    RepositoryUrl string
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    ScriptDir string
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    TrainingId string
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    TrainingScript string

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    modelId String
    The OCID of the model.
    gitBranch String
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    gitCommit String
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    repositoryUrl String
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    scriptDir String
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    trainingId String
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    trainingScript String

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    modelId string
    The OCID of the model.
    gitBranch string
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    gitCommit string
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    repositoryUrl string
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    scriptDir string
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    trainingId string
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    trainingScript string

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    model_id str
    The OCID of the model.
    git_branch str
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    git_commit str
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    repository_url str
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    script_dir str
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    training_id str
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    training_script str

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    modelId String
    The OCID of the model.
    gitBranch String
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    gitCommit String
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    repositoryUrl String
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    scriptDir String
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    trainingId String
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    trainingScript String

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ModelProvenance resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ModelProvenance Resource

    Get an existing ModelProvenance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ModelProvenanceState, opts?: CustomResourceOptions): ModelProvenance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        git_branch: Optional[str] = None,
        git_commit: Optional[str] = None,
        model_id: Optional[str] = None,
        repository_url: Optional[str] = None,
        script_dir: Optional[str] = None,
        training_id: Optional[str] = None,
        training_script: Optional[str] = None) -> ModelProvenance
    func GetModelProvenance(ctx *Context, name string, id IDInput, state *ModelProvenanceState, opts ...ResourceOption) (*ModelProvenance, error)
    public static ModelProvenance Get(string name, Input<string> id, ModelProvenanceState? state, CustomResourceOptions? opts = null)
    public static ModelProvenance get(String name, Output<String> id, ModelProvenanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    GitBranch string
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    GitCommit string
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    ModelId string
    The OCID of the model.
    RepositoryUrl string
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    ScriptDir string
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    TrainingId string
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    TrainingScript string

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    GitBranch string
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    GitCommit string
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    ModelId string
    The OCID of the model.
    RepositoryUrl string
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    ScriptDir string
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    TrainingId string
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    TrainingScript string

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    gitBranch String
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    gitCommit String
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    modelId String
    The OCID of the model.
    repositoryUrl String
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    scriptDir String
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    trainingId String
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    trainingScript String

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    gitBranch string
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    gitCommit string
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    modelId string
    The OCID of the model.
    repositoryUrl string
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    scriptDir string
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    trainingId string
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    trainingScript string

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    git_branch str
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    git_commit str
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    model_id str
    The OCID of the model.
    repository_url str
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    script_dir str
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    training_id str
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    training_script str

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    gitBranch String
    (Updatable) For model reproducibility purposes. Branch of the git repository associated with model training.
    gitCommit String
    (Updatable) For model reproducibility purposes. Commit ID of the git repository associated with model training.
    modelId String
    The OCID of the model.
    repositoryUrl String
    (Updatable) For model reproducibility purposes. URL of the git repository associated with model training.
    scriptDir String
    (Updatable) For model reproducibility purposes. Path to model artifacts.
    trainingId String
    (Updatable) The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
    trainingScript String

    (Updatable) For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    ModelProvenances can be imported using the id, e.g.

    $ pulumi import oci:DataScience/modelProvenance:ModelProvenance test_model_provenance "models/{modelId}/provenance"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci