com.amazonaws.services.neptunedata.model.CustomModelTrainingParameters Maven / Gradle / Ivy
Show all versions of aws-java-sdk-neptunedata Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.neptunedata.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains custom model training parameters. See Custom models in
* Neptune ML.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CustomModelTrainingParameters implements Serializable, Cloneable, StructuredPojo {
/**
*
* The path to the Amazon S3 location where the Python module implementing your model is located. This must point to
* a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a
* model-hpo-configuration.json file.
*
*/
private String sourceS3DirectoryPath;
/**
*
* The name of the entry point in your module of a script that performs model training and takes hyperparameters as
* command-line arguments, including fixed hyperparameters. The default is training.py.
*
*/
private String trainingEntryPointScript;
/**
*
* The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It
* should be able to run with no command-line arguments.The default is transform.py.
*
*/
private String transformEntryPointScript;
/**
*
* The path to the Amazon S3 location where the Python module implementing your model is located. This must point to
* a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a
* model-hpo-configuration.json file.
*
*
* @param sourceS3DirectoryPath
* The path to the Amazon S3 location where the Python module implementing your model is located. This must
* point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform
* script, and a model-hpo-configuration.json file.
*/
public void setSourceS3DirectoryPath(String sourceS3DirectoryPath) {
this.sourceS3DirectoryPath = sourceS3DirectoryPath;
}
/**
*
* The path to the Amazon S3 location where the Python module implementing your model is located. This must point to
* a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a
* model-hpo-configuration.json file.
*
*
* @return The path to the Amazon S3 location where the Python module implementing your model is located. This must
* point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform
* script, and a model-hpo-configuration.json file.
*/
public String getSourceS3DirectoryPath() {
return this.sourceS3DirectoryPath;
}
/**
*
* The path to the Amazon S3 location where the Python module implementing your model is located. This must point to
* a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a
* model-hpo-configuration.json file.
*
*
* @param sourceS3DirectoryPath
* The path to the Amazon S3 location where the Python module implementing your model is located. This must
* point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform
* script, and a model-hpo-configuration.json file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomModelTrainingParameters withSourceS3DirectoryPath(String sourceS3DirectoryPath) {
setSourceS3DirectoryPath(sourceS3DirectoryPath);
return this;
}
/**
*
* The name of the entry point in your module of a script that performs model training and takes hyperparameters as
* command-line arguments, including fixed hyperparameters. The default is training.py.
*
*
* @param trainingEntryPointScript
* The name of the entry point in your module of a script that performs model training and takes
* hyperparameters as command-line arguments, including fixed hyperparameters. The default is
* training.py.
*/
public void setTrainingEntryPointScript(String trainingEntryPointScript) {
this.trainingEntryPointScript = trainingEntryPointScript;
}
/**
*
* The name of the entry point in your module of a script that performs model training and takes hyperparameters as
* command-line arguments, including fixed hyperparameters. The default is training.py.
*
*
* @return The name of the entry point in your module of a script that performs model training and takes
* hyperparameters as command-line arguments, including fixed hyperparameters. The default is
* training.py.
*/
public String getTrainingEntryPointScript() {
return this.trainingEntryPointScript;
}
/**
*
* The name of the entry point in your module of a script that performs model training and takes hyperparameters as
* command-line arguments, including fixed hyperparameters. The default is training.py.
*
*
* @param trainingEntryPointScript
* The name of the entry point in your module of a script that performs model training and takes
* hyperparameters as command-line arguments, including fixed hyperparameters. The default is
* training.py.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomModelTrainingParameters withTrainingEntryPointScript(String trainingEntryPointScript) {
setTrainingEntryPointScript(trainingEntryPointScript);
return this;
}
/**
*
* The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It
* should be able to run with no command-line arguments.The default is transform.py.
*
*
* @param transformEntryPointScript
* The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment.
* It should be able to run with no command-line arguments.The default is transform.py.
*/
public void setTransformEntryPointScript(String transformEntryPointScript) {
this.transformEntryPointScript = transformEntryPointScript;
}
/**
*
* The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It
* should be able to run with no command-line arguments.The default is transform.py.
*
*
* @return The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment.
* It should be able to run with no command-line arguments.The default is transform.py.
*/
public String getTransformEntryPointScript() {
return this.transformEntryPointScript;
}
/**
*
* The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It
* should be able to run with no command-line arguments.The default is transform.py.
*
*
* @param transformEntryPointScript
* The name of the entry point in your module of a script that should be run after the best model from the
* hyperparameter search has been identified, to compute the model artifacts necessary for model deployment.
* It should be able to run with no command-line arguments.The default is transform.py.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomModelTrainingParameters withTransformEntryPointScript(String transformEntryPointScript) {
setTransformEntryPointScript(transformEntryPointScript);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSourceS3DirectoryPath() != null)
sb.append("SourceS3DirectoryPath: ").append(getSourceS3DirectoryPath()).append(",");
if (getTrainingEntryPointScript() != null)
sb.append("TrainingEntryPointScript: ").append(getTrainingEntryPointScript()).append(",");
if (getTransformEntryPointScript() != null)
sb.append("TransformEntryPointScript: ").append(getTransformEntryPointScript());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CustomModelTrainingParameters == false)
return false;
CustomModelTrainingParameters other = (CustomModelTrainingParameters) obj;
if (other.getSourceS3DirectoryPath() == null ^ this.getSourceS3DirectoryPath() == null)
return false;
if (other.getSourceS3DirectoryPath() != null && other.getSourceS3DirectoryPath().equals(this.getSourceS3DirectoryPath()) == false)
return false;
if (other.getTrainingEntryPointScript() == null ^ this.getTrainingEntryPointScript() == null)
return false;
if (other.getTrainingEntryPointScript() != null && other.getTrainingEntryPointScript().equals(this.getTrainingEntryPointScript()) == false)
return false;
if (other.getTransformEntryPointScript() == null ^ this.getTransformEntryPointScript() == null)
return false;
if (other.getTransformEntryPointScript() != null && other.getTransformEntryPointScript().equals(this.getTransformEntryPointScript()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceS3DirectoryPath() == null) ? 0 : getSourceS3DirectoryPath().hashCode());
hashCode = prime * hashCode + ((getTrainingEntryPointScript() == null) ? 0 : getTrainingEntryPointScript().hashCode());
hashCode = prime * hashCode + ((getTransformEntryPointScript() == null) ? 0 : getTransformEntryPointScript().hashCode());
return hashCode;
}
@Override
public CustomModelTrainingParameters clone() {
try {
return (CustomModelTrainingParameters) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.neptunedata.model.transform.CustomModelTrainingParametersMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}