com.amazonaws.services.sagemaker.model.ShuffleConfig Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015-2020 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.sagemaker.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * A configuration for a shuffle option for input data in a channel. If you use S3Prefix for
 * S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile,
 * the order of the S3 object references in the ManifestFile is shuffled. If you use
 * AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is
 * shuffled. The shuffling order is determined using the Seed value.
 * 
 * 
 * For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With
 * large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce
 * bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with
 * S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the
 * content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ShuffleConfig implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * Determines the shuffling order in ShuffleConfig value.
     * 
     */
    private Long seed;

    /**
     * 
     * Determines the shuffling order in ShuffleConfig value.
     * 
     * 
     * @param seed
     *        Determines the shuffling order in ShuffleConfig value.
     */

    public void setSeed(Long seed) {
        this.seed = seed;
    }

    /**
     * 
     * Determines the shuffling order in ShuffleConfig value.
     * 
     * 
     * @return Determines the shuffling order in ShuffleConfig value.
     */

    public Long getSeed() {
        return this.seed;
    }

    /**
     * 
     * Determines the shuffling order in ShuffleConfig value.
     * 
     * 
     * @param seed
     *        Determines the shuffling order in ShuffleConfig value.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ShuffleConfig withSeed(Long seed) {
        setSeed(seed);
        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 (getSeed() != null)
            sb.append("Seed: ").append(getSeed());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof ShuffleConfig == false)
            return false;
        ShuffleConfig other = (ShuffleConfig) obj;
        if (other.getSeed() == null ^ this.getSeed() == null)
            return false;
        if (other.getSeed() != null && other.getSeed().equals(this.getSeed()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getSeed() == null) ? 0 : getSeed().hashCode());
        return hashCode;
    }

    @Override
    public ShuffleConfig clone() {
        try {
            return (ShuffleConfig) 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.sagemaker.model.transform.ShuffleConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}