software.amazon.awssdk.services.forecast.model.Metrics Maven / Gradle / Ivy
Show all versions of forecast Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.forecast.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides metrics that are used to evaluate the performance of a predictor. This object is part of the
* WindowSummary object.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Metrics implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField RMSE_FIELD = SdkField. builder(MarshallingType.DOUBLE).memberName("RMSE")
.getter(getter(Metrics::rmse)).setter(setter(Builder::rmse))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RMSE").build()).build();
private static final SdkField> WEIGHTED_QUANTILE_LOSSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("WeightedQuantileLosses")
.getter(getter(Metrics::weightedQuantileLosses))
.setter(setter(Builder::weightedQuantileLosses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WeightedQuantileLosses").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(WeightedQuantileLoss::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ERROR_METRICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ErrorMetrics")
.getter(getter(Metrics::errorMetrics))
.setter(setter(Builder::errorMetrics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorMetrics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ErrorMetric::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField AVERAGE_WEIGHTED_QUANTILE_LOSS_FIELD = SdkField
. builder(MarshallingType.DOUBLE)
.memberName("AverageWeightedQuantileLoss")
.getter(getter(Metrics::averageWeightedQuantileLoss))
.setter(setter(Builder::averageWeightedQuantileLoss))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AverageWeightedQuantileLoss")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RMSE_FIELD,
WEIGHTED_QUANTILE_LOSSES_FIELD, ERROR_METRICS_FIELD, AVERAGE_WEIGHTED_QUANTILE_LOSS_FIELD));
private static final long serialVersionUID = 1L;
private final Double rmse;
private final List weightedQuantileLosses;
private final List errorMetrics;
private final Double averageWeightedQuantileLoss;
private Metrics(BuilderImpl builder) {
this.rmse = builder.rmse;
this.weightedQuantileLosses = builder.weightedQuantileLosses;
this.errorMetrics = builder.errorMetrics;
this.averageWeightedQuantileLoss = builder.averageWeightedQuantileLoss;
}
/**
*
* The root-mean-square error (RMSE).
*
*
* @return The root-mean-square error (RMSE).
* @deprecated This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
*/
@Deprecated
public final Double rmse() {
return rmse;
}
/**
* For responses, this returns true if the service returned a value for the WeightedQuantileLosses property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasWeightedQuantileLosses() {
return weightedQuantileLosses != null && !(weightedQuantileLosses instanceof SdkAutoConstructList);
}
/**
*
* An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal
* probability. The distribution in this case is the loss function.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasWeightedQuantileLosses} method.
*
*
* @return An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal
* probability. The distribution in this case is the loss function.
*/
public final List weightedQuantileLosses() {
return weightedQuantileLosses;
}
/**
* For responses, this returns true if the service returned a value for the ErrorMetrics property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasErrorMetrics() {
return errorMetrics != null && !(errorMetrics instanceof SdkAutoConstructList);
}
/**
*
* Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean
* absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error
* (WAPE).
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasErrorMetrics} method.
*
*
* @return Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE),
* mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage
* error (WAPE).
*/
public final List errorMetrics() {
return errorMetrics;
}
/**
*
* The average value of all weighted quantile losses.
*
*
* @return The average value of all weighted quantile losses.
*/
public final Double averageWeightedQuantileLoss() {
return averageWeightedQuantileLoss;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(rmse());
hashCode = 31 * hashCode + Objects.hashCode(hasWeightedQuantileLosses() ? weightedQuantileLosses() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasErrorMetrics() ? errorMetrics() : null);
hashCode = 31 * hashCode + Objects.hashCode(averageWeightedQuantileLoss());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Metrics)) {
return false;
}
Metrics other = (Metrics) obj;
return Objects.equals(rmse(), other.rmse()) && hasWeightedQuantileLosses() == other.hasWeightedQuantileLosses()
&& Objects.equals(weightedQuantileLosses(), other.weightedQuantileLosses())
&& hasErrorMetrics() == other.hasErrorMetrics() && Objects.equals(errorMetrics(), other.errorMetrics())
&& Objects.equals(averageWeightedQuantileLoss(), other.averageWeightedQuantileLoss());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Metrics").add("RMSE", rmse())
.add("WeightedQuantileLosses", hasWeightedQuantileLosses() ? weightedQuantileLosses() : null)
.add("ErrorMetrics", hasErrorMetrics() ? errorMetrics() : null)
.add("AverageWeightedQuantileLoss", averageWeightedQuantileLoss()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RMSE":
return Optional.ofNullable(clazz.cast(rmse()));
case "WeightedQuantileLosses":
return Optional.ofNullable(clazz.cast(weightedQuantileLosses()));
case "ErrorMetrics":
return Optional.ofNullable(clazz.cast(errorMetrics()));
case "AverageWeightedQuantileLoss":
return Optional.ofNullable(clazz.cast(averageWeightedQuantileLoss()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Metrics) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The root-mean-square error (RMSE).
*
*
* @param rmse
* The root-mean-square error (RMSE).
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
*/
@Deprecated
Builder rmse(Double rmse);
/**
*
* An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal
* probability. The distribution in this case is the loss function.
*
*
* @param weightedQuantileLosses
* An array of weighted quantile losses. Quantiles divide a probability distribution into regions of
* equal probability. The distribution in this case is the loss function.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder weightedQuantileLosses(Collection weightedQuantileLosses);
/**
*
* An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal
* probability. The distribution in this case is the loss function.
*
*
* @param weightedQuantileLosses
* An array of weighted quantile losses. Quantiles divide a probability distribution into regions of
* equal probability. The distribution in this case is the loss function.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder weightedQuantileLosses(WeightedQuantileLoss... weightedQuantileLosses);
/**
*
* An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal
* probability. The distribution in this case is the loss function.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.forecast.model.WeightedQuantileLoss.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.forecast.model.WeightedQuantileLoss#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.forecast.model.WeightedQuantileLoss.Builder#build()} is called
* immediately and its result is passed to {@link #weightedQuantileLosses(List)}.
*
* @param weightedQuantileLosses
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.forecast.model.WeightedQuantileLoss.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #weightedQuantileLosses(java.util.Collection)
*/
Builder weightedQuantileLosses(Consumer... weightedQuantileLosses);
/**
*
* Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean
* absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error
* (WAPE).
*
*
* @param errorMetrics
* Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE),
* mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average
* percentage error (WAPE).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorMetrics(Collection errorMetrics);
/**
*
* Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean
* absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error
* (WAPE).
*
*
* @param errorMetrics
* Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE),
* mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average
* percentage error (WAPE).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorMetrics(ErrorMetric... errorMetrics);
/**
*
* Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean
* absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error
* (WAPE).
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.forecast.model.ErrorMetric.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.forecast.model.ErrorMetric#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.forecast.model.ErrorMetric.Builder#build()} is called immediately and
* its result is passed to {@link #errorMetrics(List)}.
*
* @param errorMetrics
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.forecast.model.ErrorMetric.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #errorMetrics(java.util.Collection)
*/
Builder errorMetrics(Consumer... errorMetrics);
/**
*
* The average value of all weighted quantile losses.
*
*
* @param averageWeightedQuantileLoss
* The average value of all weighted quantile losses.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder averageWeightedQuantileLoss(Double averageWeightedQuantileLoss);
}
static final class BuilderImpl implements Builder {
private Double rmse;
private List weightedQuantileLosses = DefaultSdkAutoConstructList.getInstance();
private List errorMetrics = DefaultSdkAutoConstructList.getInstance();
private Double averageWeightedQuantileLoss;
private BuilderImpl() {
}
private BuilderImpl(Metrics model) {
rmse(model.rmse);
weightedQuantileLosses(model.weightedQuantileLosses);
errorMetrics(model.errorMetrics);
averageWeightedQuantileLoss(model.averageWeightedQuantileLoss);
}
@Deprecated
public final Double getRmse() {
return rmse;
}
@Deprecated
public final void setRmse(Double rmse) {
this.rmse = rmse;
}
@Override
@Deprecated
public final Builder rmse(Double rmse) {
this.rmse = rmse;
return this;
}
public final List getWeightedQuantileLosses() {
List result = WeightedQuantileLossesCopier.copyToBuilder(this.weightedQuantileLosses);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setWeightedQuantileLosses(Collection weightedQuantileLosses) {
this.weightedQuantileLosses = WeightedQuantileLossesCopier.copyFromBuilder(weightedQuantileLosses);
}
@Override
public final Builder weightedQuantileLosses(Collection weightedQuantileLosses) {
this.weightedQuantileLosses = WeightedQuantileLossesCopier.copy(weightedQuantileLosses);
return this;
}
@Override
@SafeVarargs
public final Builder weightedQuantileLosses(WeightedQuantileLoss... weightedQuantileLosses) {
weightedQuantileLosses(Arrays.asList(weightedQuantileLosses));
return this;
}
@Override
@SafeVarargs
public final Builder weightedQuantileLosses(Consumer... weightedQuantileLosses) {
weightedQuantileLosses(Stream.of(weightedQuantileLosses)
.map(c -> WeightedQuantileLoss.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getErrorMetrics() {
List result = ErrorMetricsCopier.copyToBuilder(this.errorMetrics);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setErrorMetrics(Collection errorMetrics) {
this.errorMetrics = ErrorMetricsCopier.copyFromBuilder(errorMetrics);
}
@Override
public final Builder errorMetrics(Collection errorMetrics) {
this.errorMetrics = ErrorMetricsCopier.copy(errorMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder errorMetrics(ErrorMetric... errorMetrics) {
errorMetrics(Arrays.asList(errorMetrics));
return this;
}
@Override
@SafeVarargs
public final Builder errorMetrics(Consumer... errorMetrics) {
errorMetrics(Stream.of(errorMetrics).map(c -> ErrorMetric.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Double getAverageWeightedQuantileLoss() {
return averageWeightedQuantileLoss;
}
public final void setAverageWeightedQuantileLoss(Double averageWeightedQuantileLoss) {
this.averageWeightedQuantileLoss = averageWeightedQuantileLoss;
}
@Override
public final Builder averageWeightedQuantileLoss(Double averageWeightedQuantileLoss) {
this.averageWeightedQuantileLoss = averageWeightedQuantileLoss;
return this;
}
@Override
public Metrics build() {
return new Metrics(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}