Module SageMaker.ModelCard

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html

type container = {
  1. nearest_model_name : string option;
  2. model_data_url : string option;
  3. image : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html

and business_details = {
  1. business_stakeholders : string option;
  2. line_of_business : string option;
  3. business_problem : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html

and function_ = {
  1. condition : string option;
  2. function_ : string option;
  3. facet : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-function.html

and tag = {
  1. value : string;
  2. key : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html

and user_context = {
  1. domain_id : string option;
  2. user_profile_arn : string option;
  3. user_profile_name : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html

and intended_uses = {
  1. intended_uses : string option;
  2. factors_affecting_model_efficiency : string option;
  3. purpose_of_model : string option;
  4. risk_rating : string option;
  5. explanations_for_risk_rating : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html

and security_config = {
  1. kms_key_id : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-securityconfig.html

and training_metric = {
  1. value : float;
  2. notes : string option;
  3. name : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html

and training_hyper_parameter = {
  1. value : string;
  2. name : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html

and source_algorithm = {
  1. model_data_url : string option;
  2. algorithm_name : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html

and training_environment = {
  1. container_image : string list option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingenvironment.html

and additional_information = {
  1. ethical_considerations : string option;
  2. caveats_and_recommendations : string option;
  3. custom_details : string Stdlib__Map.Make(Stdlib.String).t option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html

and inference_environment = {
  1. container_image : string list option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferenceenvironment.html

and model_package_creator = {
  1. user_profile_name : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagecreator.html

and metric_data_items = {
  1. x_axis_name : string list option;
  2. type_ : string;
  3. value : Yojson.Safe.t;
  4. y_axis_name : string list option;
  5. notes : string option;
  6. name : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html

and metric_group = {
  1. name : string;
  2. metric_data : metric_data_items list;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html

and objective_function = {
  1. function_ : function_ option;
  2. notes : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html

and training_job_details = {
  1. training_metrics : training_metric list option;
  2. hyper_parameters : training_hyper_parameter list option;
  3. training_arn : string option;
  4. user_provided_training_metrics : training_metric list option;
  5. training_environment : training_environment option;
  6. training_datasets : string list option;
  7. user_provided_hyper_parameters : training_hyper_parameter list option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html

and model_overview = {
  1. model_owner : string option;
  2. model_artifact : string list option;
  3. algorithm_type : string option;
  4. model_name : string option;
  5. inference_environment : inference_environment option;
  6. problem_type : string option;
  7. model_description : string option;
  8. model_version : float option;
  9. model_creator : string option;
  10. model_id : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html

and inference_specification = {
  1. containers : container list;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferencespecification.html

and model_package_details = {
  1. model_package_group_name : string option;
  2. task : string option;
  3. created_by : model_package_creator option;
  4. approval_description : string option;
  5. model_approval_status : string option;
  6. model_package_version : float option;
  7. model_package_description : string option;
  8. model_package_name : string option;
  9. model_package_status : string option;
  10. source_algorithms : source_algorithm list option;
  11. inference_specification : inference_specification option;
  12. model_package_arn : string option;
  13. domain : string option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html

and training_details = {
  1. objective_function : objective_function option;
  2. training_observations : string option;
  3. training_job_details : training_job_details option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html

and evaluation_detail = {
  1. datasets : string list option;
  2. evaluation_observation : string option;
  3. metric_groups : metric_group list option;
  4. metadata : string Stdlib__Map.Make(Stdlib.String).t option;
  5. evaluation_job_arn : string option;
  6. name : string;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html

and content = {
  1. intended_uses : intended_uses option;
  2. additional_information : additional_information option;
  3. model_overview : model_overview option;
  4. training_details : training_details option;
  5. evaluation_details : evaluation_detail list option;
  6. model_package_details : model_package_details option;
  7. business_details : business_details option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html

type properties = {
  1. last_modified_by : user_context option;
  2. model_card_name : string;
  3. model_card_status : string;
  4. created_by : user_context option;
  5. security_config : security_config option;
  6. content : content;
  7. tags : tag list option;
}

see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html;

val make_properties : ?last_modified_by:user_context -> model_card_name:string -> model_card_status:string -> ?created_by:user_context -> ?security_config:security_config -> content:content -> ?tags:tag list -> unit -> properties
val make_container : ?nearest_model_name:string -> ?model_data_url:string -> image:string -> unit -> container
val make_business_details : ?business_stakeholders:string -> ?line_of_business:string -> ?business_problem:string -> unit -> business_details
val make_function_ : ?condition:string -> ?function_:string -> ?facet:string -> unit -> function_
val make_tag : value:string -> key:string -> unit -> tag
val make_user_context : ?domain_id:string -> ?user_profile_arn:string -> ?user_profile_name:string -> unit -> user_context
val make_intended_uses : ?intended_uses:string -> ?factors_affecting_model_efficiency:string -> ?purpose_of_model:string -> ?risk_rating:string -> ?explanations_for_risk_rating:string -> unit -> intended_uses
val make_security_config : ?kms_key_id:string -> unit -> security_config
val make_training_metric : value:float -> ?notes:string -> name:string -> unit -> training_metric
val make_training_hyper_parameter : value:string -> name:string -> unit -> training_hyper_parameter
val make_source_algorithm : ?model_data_url:string -> algorithm_name:string -> unit -> source_algorithm
val make_training_environment : ?container_image:string list -> unit -> training_environment
val make_additional_information : ?ethical_considerations:string -> ?caveats_and_recommendations:string -> ?custom_details:string Stdlib__Map.Make(Stdlib.String).t -> unit -> additional_information
val make_inference_environment : ?container_image:string list -> unit -> inference_environment
val make_model_package_creator : ?user_profile_name:string -> unit -> model_package_creator
val make_metric_data_items : ?x_axis_name:string list -> type_:string -> value:Yojson.Safe.t -> ?y_axis_name:string list -> ?notes:string -> name:string -> unit -> metric_data_items
val make_metric_group : name:string -> metric_data:metric_data_items list -> unit -> metric_group
val make_objective_function : ?function_:function_ -> ?notes:string -> unit -> objective_function
val make_training_job_details : ?training_metrics:training_metric list -> ?hyper_parameters:training_hyper_parameter list -> ?training_arn:string -> ?user_provided_training_metrics:training_metric list -> ?training_environment:training_environment -> ?training_datasets:string list -> ?user_provided_hyper_parameters:training_hyper_parameter list -> unit -> training_job_details
val make_model_overview : ?model_owner:string -> ?model_artifact:string list -> ?algorithm_type:string -> ?model_name:string -> ?inference_environment:inference_environment -> ?problem_type:string -> ?model_description:string -> ?model_version:float -> ?model_creator:string -> ?model_id:string -> unit -> model_overview
val make_inference_specification : containers:container list -> unit -> inference_specification
val make_model_package_details : ?model_package_group_name:string -> ?task:string -> ?created_by:model_package_creator -> ?approval_description:string -> ?model_approval_status:string -> ?model_package_version:float -> ?model_package_description:string -> ?model_package_name:string -> ?model_package_status:string -> ?source_algorithms:source_algorithm list -> ?inference_specification:inference_specification -> ?model_package_arn:string -> ?domain:string -> unit -> model_package_details
val make_training_details : ?objective_function:objective_function -> ?training_observations:string -> ?training_job_details:training_job_details -> unit -> training_details
val make_evaluation_detail : ?datasets:string list -> ?evaluation_observation:string -> ?metric_groups:metric_group list -> ?metadata:string Stdlib__Map.Make(Stdlib.String).t -> ?evaluation_job_arn:string -> name:string -> unit -> evaluation_detail
val make_content : ?intended_uses:intended_uses -> ?additional_information:additional_information -> ?model_overview:model_overview -> ?training_details:training_details -> ?evaluation_details:evaluation_detail list -> ?model_package_details:model_package_details -> ?business_details:business_details -> unit -> content
val yojson_of_container : container -> Yojson.Safe.t
val yojson_of_business_details : business_details -> Yojson.Safe.t
val yojson_of_function_ : function_ -> Yojson.Safe.t
val yojson_of_tag : tag -> [> `Assoc of (string * Yojson.Safe.t) list ]
val yojson_of_user_context : user_context -> [> `Assoc of (string * Yojson.Safe.t) list ]
val yojson_of_intended_uses : intended_uses -> Yojson.Safe.t
val yojson_of_security_config : security_config -> [> `Assoc of (string * Yojson.Safe.t) list ]
val yojson_of_training_metric : training_metric -> Yojson.Safe.t
val yojson_of_training_hyper_parameter : training_hyper_parameter -> Yojson.Safe.t
val yojson_of_source_algorithm : source_algorithm -> Yojson.Safe.t
val yojson_of_training_environment : training_environment -> Yojson.Safe.t
val yojson_of_additional_information : additional_information -> Yojson.Safe.t
val yojson_of_inference_environment : inference_environment -> Yojson.Safe.t
val yojson_of_model_package_creator : model_package_creator -> Yojson.Safe.t
val yojson_of_metric_data_items : metric_data_items -> Yojson.Safe.t
val yojson_of_metric_group : metric_group -> Yojson.Safe.t
val yojson_of_objective_function : objective_function -> Yojson.Safe.t
val yojson_of_training_job_details : training_job_details -> Yojson.Safe.t
val yojson_of_model_overview : model_overview -> Yojson.Safe.t
val yojson_of_inference_specification : inference_specification -> Yojson.Safe.t
val yojson_of_model_package_details : model_package_details -> Yojson.Safe.t
val yojson_of_training_details : training_details -> Yojson.Safe.t
val yojson_of_evaluation_detail : evaluation_detail -> Yojson.Safe.t
val yojson_of_content : content -> [> `Assoc of (string * Yojson.Safe.t) list ]
val yojson_of_properties : properties -> [> `Assoc of (string * Yojson.Safe.t) list ]
type attributes = {
  1. ref_ : string;
  2. last_modified_by__user_profile_arn : string;
  3. created_by__domain_id : string;
  4. model_card_arn : string;
  5. created_by__user_profile_name : string;
  6. creation_time : string;
  7. last_modified_time : string;
  8. last_modified_by__domain_id : string;
  9. model_card_version : int;
  10. model_card_processing_status : string;
  11. last_modified_by__user_profile_name : string;
  12. created_by__user_profile_arn : string;
}
val create_attributes : string -> attributes
val cloudformation_type : string