Skip to main content

Namespace Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting

Classes​

AggregationTypeOptionsQueryResponseContext​

ArtifactAnnotationContextDto​

ArtifactMetadataResponseContextDto​

AutoContext​

AutoModelConfigStatsResponseContext​

Get response context used in AutoConfigSummaryResource

AutoPpoContext​

BodyAttachDatabaseContext​

Post body response context for AttachDatabaseResource

BodyBuildInfoArchiveContext​

Put body context used in BuildInfoArchiveResource

BodyBuildinfoAssignmentsGeneratorsDto​

Contains a list of generator block ids to assign to a buildinfo.

BodyBuildinfoAssignmentsLocationsDto​

Contains a list of location ids to assign to a buildinfo.

BodyBuildinfoConfigContext​

Put body context for BuildInfoConfigResource

BodyConsumptionContext​

BodyConsumptionPbmDto​

Post, put body context for ConsumptionPBMResource

BodyConsumptionPbmInputsDto​

BodyCvModelRunContext​

The put body context for CustomCrossValidationModelRunResource

BodyDataSourceAttributesContext​

Put body context for DataSourceAttributesResource

BodyDataSourcesCommitDto​

BodyGeneratorConfigurationContext​

BodyGeneratorConfigurationsContext​

BodyHierarchyConfigContext​

BodyHierarchyDto​

BodyLocationContext​

Put, Post body context for LocationsResource, LocationResource

BodyModelThresholdsContext​

BodyPpoContext​

Post body context for XperimentBuildPipelineConfigResource

BodyPredictionCallContext​

BodyScenarioContext​

BodyScenariosContext​

BodyXperimentBuildsAssignmentsGeneratorsDto​

BodyXperimentBuildsAssingmentsLocationsDto​

BuildFillInputContext​

Get response context for RebuildsResource

BuildFillOutputContext​

Get response context for BuildInfoResource, BuildInfosResource

BuildInfoInputContext​

Build info context that will act as input from user that can be converted

into an output context to process user input information if necessary.

Example: user input can be "advanced folds" (stored in BuildInfoInputContext)

which would be processed into a fold number and stored in the BuildInfoOutputContext

See Also:

BuildInfoOutputContext

BuildInfoInputConfig

BuildInfoOutputContext​

Build info context that will act as processed user input from BuildInfoInputContext.

BuildInfoResponseContext​

Get response context for BuildInfoResource

BuildInfoStateResponseContext​

Get response context for BuildInfoStateResource.

BuildStatisticsResponseContext​

Get response context for BuildInfoAssignmentsSummaryResource

CleanMethodsResponseContext​

Get response context for CleanMethodsResource

ConsumptionContext​

CrossValidationStrategySplitsContext​

Contains all cv strategies.

CustomInternalModelRunContext​

CustomModelRunContext​

Data​

DataProfileResponseRawContext​

Get response context for TargetSignificanceResource

DataSourceConnectionNameResponseContext​

Get response context for DataSourceConnectionResource

DataSourceTargetResponseContext​

Get response context for DataSourceTargetResource

DataTableColumnInfoContext​

Column info used in DataTableContext

DataTableContext​

DeleteProjectResourceResponseContext​

DeployContext​

The deploy context that directly maps to a ModelingConfig.

See Also:

ModelingConfig

PPOContext

EvalPortionsToIgnore​

FeatureSelectionContext​

The feature selection context that directly maps to a FeatureSelectionConfig.

Attributes:

pipelines (List[FeatureSelectionPipelineContext]): list of pipelines to run

See Also:

FeatureSelectionPipelineContext

PPOConfig

FeatureSelectionConfig

FeatureSelectionPipelineContext​

The feature selection context that directly maps to a FeatureSelectionConfig.

Attributes:

name (str): The name of the feature selection pipeline

split_aggregation_type (str): The method for aggregating feature selection importance scores across splits.

algorithm_aggregation_type (str): The method of aggregating selected features by algorithm into the global

list of selected features.

split_run_type (str): The method of what data splits to run the feature selection algorithms against.

See Also:

PPOConfig

FeatureSelectionConfig

FileAnnotationDto​

FitPortionsToIgnore​

ForecastConfigCollectionContext​

Forecast config collection context for ForecastResource.

ForecastConfigContext​

Get response context for ForecastResource

ForecastInfoContext​

Forecast info context returned by ForecastResource.

ForecastMetadata​

ForecastSeriesPointContext​

One row of the forecast vs actuals long-format time series.

ForecastSummaryStatsContext​

Per-feature summary statistics derived from a loaded FeaturePredictionOutput snapshot. MAE and MAPE are null when no rows overlap (or when every overlapping row has actual_value equal to 0 for MAPE).

FrequencyOverrideOptionsQueryResponseContext​

GeneralContext​

GeneratorPackagesApplyBodyContext​

GetAggregationTypeOptionsResourceContext​

GetAutoConfigResourceResponseContext​

GetAutoConfigSummaryResourceResponseContext​

GetBuildInfoAssignmentsGeneratorsLocationsResourceResponseContext​

GetBuildInfoAssignmentsSummaryResourceResponseContext​

GetBuildInfoAuditResourceResponseContext​

GetBuildInfoBacktestResourceResponseContext​

GetBuildInfoConfigResourceResponseContext​

GetBuildInfoResourceResponseContext​

GetBuildInfosResourceResponseContext​

GetBuildInfoStateResourceResponseContext​

GetBuildSummaryResourceResponseContext​

GetCleanMethodsResourceResponseContext​

GetColumnDataResourceResponseContext​

GetConsumptionGroupResourceResponseContext​

GetConsumptionGroupsResourceResponseContext​

GetCrossValidationGuardrailsResourceResponseContext​

GetCrossValidationSplitsResourceResponseContext​

GetCustomCrossValidationModelRunResourceResponseContext​

GetCustomModelRunPortionsResourceResponseContext​

GetDataExplorationOptionsResourceResponseContext​

GetDataExplorationResourceResponseContext​

GetDataSourceAttributesResourceResponseContext​

GetDataSourceConnectionResourceResponseContext​

GetDataSourceDataFormResourceResponseContext​

GetDataSourceDataFormSummaryResourceResponseContext​

GetDataSourceMissingValuesResourceResponseContext​

GetDataSourceResourceResponseContext​

GetDataSourcesAttributesResourceResponseContext​

GetDataSourcesConnectionsResourceResponseContext​

GetDataSourcesDataFormsResourceResponseContext​

GetDataSourceSnapshotCollectionLagsResourceResponseContext​

GetDataSourceSnapshotMessagesResourceResponseContext​

GetDataSourcesSnapshotsExecutionTimesResourceResponseContext​

GetDataSourcesSnapshotsResourceResponseContext​

GetDataSourceTargetResourceResponseContext​

GetDatasourceTargetStatResponseContext​

GetDatatableIndexResourceResponseContext​

GetDeploymentSummaryResourceResponseContext​

GetEventsAssignmentCountResourceResponseContext​

GetExploreOptionsResponseContext​

Get response context for DataExplorationOptionsResource

GetExploreResponseContext​

Get response context for DataExplorationResource

GetFeatureEffectsResourceResponseContext​

GetFeatureImpactResourceResponseContext​

GetFeaturePredictionOutputHistoryResourceResponseContext​

GetFeaturesGeneratedDatatypesResourceResponseContext​

GetFeaturesGeneratedResourceResponseContext​

GetFeaturesSummaryResourceResponseContext​

GetFeatureTransformersDistributionResourceResponseContext​

GetFeatureValuesDataResourceResponseContext​

GetForecastInfoResourceResponseContext​

GetForecastOptionsResourceResponseContext​

GetForecastResourceResponseContext​

GetFrequencyOverrideOptionsResourceContext​

GetGeneratorCompatibilityResourceResponseContext​

GetGeneratorConfigurationsResourceResponseContext​

GetGlobalFeatureGeneralizationResourceResponseContext​

GetGroupingOptionsResourceResponseContext​

GetGroupingResourceResponseContext​

GetGroupingTargetDistributionResourceResponseContext​

GetHealthBaselineWinMarginResourceResponseContext​

GetHealthResourceResponseContext​

GetHealthSummaryStatisticsResourceResponseContext​

GetHierarchyConfigResourceResponseContext​

GetHierarchySourceDatMetricsResponseContext​

GetJobCheckpointResourceResponseContext​

GetLatestFeaturePredictionOutputResourceResponseContext​

GetLocationResourceResponseContext​

GetLocationsAssignmentCountResourceResponseContext​

GetLocationsResourceResponseContext​

GetMetricCollectionResourceResponseContext​

GetMlTypeOptionsResourceContext​

GetModelCollectionResourceResponseContext​

GetModelMetadataResourceResponseContext​

GetModelThresholdsConfigResourceResponseContext​

GetPipelineMetricResultResourceResponseContext​

GetPipelineTimeseriesDataResourceResponseContext​

GetPredictionCallResourceResponseContext​

GetPredictionCallsResourceResponseContext​

GetPredictionExplanationsResourceResponseContext​

GetPredictionMetricResultResourceResponseContext​

GetPredictionsResourceResponseContext​

GetPredictionTimeseriesDataResourceResponseContext​

GetProjectDatabaseQueryResourceResponseContext​

GetProjectResourceResponseContext​

GetProjectResponseContext​

Get response context for ProjectResource

GetProjectsResourceResponseContext​

GetRebuildOptionsFillPartialNumbersResourceResponseContext​

GetRebuildOptionsFillPartialResourceResponseContext​

GetRebuildOptionsFillResourceResponseContext​

GetRebuildOptionsTypeResourceResponseContext​

GetRebuildsResourceResponseContext​

GetResponseConsumptionDataTableContext​

Get response context for ConsumptionGroupsResource

GetResponseXperimentBuildContext​

Get response context for XperimentBuildResource

GetResponseXperimentKernelContext​

Get response context for XperimentKernelResource

GetScenarioFeatureDataResourceResponseContext​

GetScenarioResourceResponseContext​

GetScenariosResourceResponseContext​

GetSelectionAlgorithmCollectionResourceResponseContext​

GetTargetSignificanceResourceResponseContext​

GetTargetSummaryResourceResponseContext​

GetTransformerCollectionResourceResponseContext​

GetTuningStrategiesResourceResponseContext​

GetUploadOptionsResourceResponseContext​

GetXperimentBuildAllowedModelsResourceResponseContext​

GetXperimentBuildAssignmentsGeneratorsResourceResponseContext​

GetXperimentBuildAssignmentsLocationsResourceResponseContext​

GetXperimentBuildBacktestResourceResponseContext​

GetXperimentBuildEventAnalysisResourceResponseContext​

GetXperimentBuildHealthResourceResponseContext​

GetXperimentBuildModelRunSchemaResourceResponseContext​

GetXperimentBuildPipelineConfigResourceResponseContext​

GetXperimentBuildResourceResponseContext​

GetXperimentBuildsAuditResourceResponseContext​

GetXperimentBuildSelectedFeaturesAnalysisResourceResponseContext​

GetXperimentBuildSelectedFeaturesResourceResponseContext​

GetXperimentBuildsFilterResourceResponseContext​

GetXperimentBuildsResourceResponseContext​

GetXperimentBuildTemporalAnalysisResourceResponseContext​

GetXperimentBuildTrainingResourceResponseContext​

GetXperimentKernelResourceResponseContext​

GetXperimentKernelsResourceResponseContext​

GetXperimentSetPredictionResultsResourceResponseContext​

GroupingContext​

HyperparameterTuningContext​

The Hyperparameter Tuning Context that makes up part of the ppo configuration. This object maps to a

HyperparameterTuningConfig

Attributes:

strategy (str): The hyperparameter tuning strategy.

iteration_scale (int): The iteration scale [1-10]. The smaller the number, the less iterations that are run. The iteration

scale acts is an abstraction on top of model specific iterations. Must be set if iterations is None.

iterations (int, optional): The exact amount of iterations to run for that particular model. Must be set if iteration_scale is None.

early_stopping_proportion (float): The proportion of iterations [0 -1]to run without an improvement in the metric score before ending

hypertuning early.

n_hypertune_workers (int): THe number of hypertune workers that are allowed to be run at the same time for a particular

model during training. Use -1 to use the max number of allowed workers by the engine. If the provided number

is greater than th max number of allowed workers than it will set it to the max number of allowed workers.

See Also:

PPOContext

HyperparameterTuningConfig

IntItemIdentifierContext​

Contains an int item identifier

IntItemsIdentifierContext​

Contains a list of item identifiers

IXperiflowResponseContext​

LocationContext​

Get response context for LocationResource

MlTypeOptionsQueryResponseContext​

ModelDatarowLowerThresholdContextDto​

ModelDatarowThresholdContextDto​

ModelDatarowUpperThresholdContextDto​

ModelRebuildBodyContext​

Post body context for RebuildsResource

ModelRunSchemaContext​

ModelRunSchema context. See also ModelRunSchema

NullableIntItemIdentifierXperiflowResponseContext​

NullDataXperiflowResponseContext​

PaginationColumnInfoContext​

Used in IQueryPaginationBaseModel, IResponseDataTableBaseModel

PostConsumptionGroupsResourceResponseContext​

PostDataSourceFeatureCommitPbmResourceResponseContext​

PostDataSourcesRefreshPbmResourceResponseContext​

PostDataSourceTargetCommitPbmResourceResponseContext​

PostDataSourceUpdatePbmResourceResponseContext​

PostGeneratorConfigurationsResourceResponseContext​

PostLocationsResourceResponseContext​

PostRebuildsResourceResponseContext​

PostScenariosResourceResponseContext​

PpoContext​

The PPO Context that directly maps to a json ppo config.

ProjectDatabaseQueryContext​

Get, post query/body context for ProjectDatabaseQueryResource

PutBodyAutoPpoContext​

Body context for AutoConfigResource

PutBodyProjectContext​

Put body context for ProjectResource

QueryBuildStatisticsResponseContext​

Get response context for BuildSummaryResource

QueryConsumptionResponseContext​

Get response context for ConsumptionGroupResource

QueryCrossValidationModelRunResponseContext​

The Get Response context for CustomCrossValidationModelRunResource

QueryCrossValidationPortionsResponseContext​

The Get response context for CustomModelRunPortionsResource

QueryCrossValidationStrategySplitsResponseContext​

Get response context for CrossValidationSplitsResource

QueryDataProfileResponseContext​

Get response context for GroupingTargetDistributionResource

QueryDataSourceAttributesResponseContext​

Get response context for DataSourceAttributesResource

QueryDataSourceStatisticsResponseContext​

Get response context for DataSourceDataFormSummaryResource

QueryDatatableIndexResponseContext​

The Response Context for DatatableIndexResource

QueryGuardrailsResponseContext​

Get response context for CrossValidationGuardrailsResource

QueryModelRebuildPresentationResponseContext​

Get response context for RebuildsResource

QueryPaginationDataTableResponseContext​

Filterable response object

QueryPipelineOverviewResponseContext​

Get response context used in BuildinfoBacktestResource

QueryResponsePpoContext​

Get response context for XperimentBuildPipelineConfigResource

QueryUtilizationStatisticsResponseContext​

Get response context for DeploymentSummaryResource

RebuildHealthResponseContext​

Get response context for PredictionCallsResource

ResponseAnalysisPredictionContext​

Get response context for XperimentSetPredictionResultsResource

ResponseDataSourceDataFormNameContext​

Get response context for DataSourceDataFormResource

ResponseFeaturePredictionOutputContext​

Response body for the latest FeaturePredictionOutput endpoint.

ResponseHealthSummaryStatisticsContext​

Get response context for HealthSummaryStatisticsResource

ResponsePipelineSelectedFeaturesContext​

Get response context for XperimentBuildSelectedFeaturesResource

ResponsePredictionCallContext​

Get response context for PredictionCallsResource

ResponsePredictionCallsContext​

Get response context for PredictionCallsResource

ResponseSchedulePredictContext​

Get response context for EventResource

ResponseStatisticsContext​

ResponseTuningStrategiesContext​

Get response context for TuningStrategiesResource

ResponseXperimentBuildSelectedFeaturesAnalysisContext​

Get response context for XperimentBuildSelectedFeaturesAnalysisResource

ResponseXperimentBuildTemporalAnalysisContext​

Get response context for XperimentBuildTemporalAnalysisResource

ResponseXperimentBuildTrainingContext​

Get response context for XperimentBuildTrainingResource

ScenarioFeatureDataBodyContext​

SerializedInstanceContext​

SerializedInstanceMetadataContext​

SerializedObjectMetadataContext​

StatisticsSelectedFeatures​

Get response context for XperimentBuildSelectedFeaturesResource

StatisticsXperimentBuildTrainingContext​

Get response context for XperimentBuildTrainingResource

TargetSummaryResponseContext​

Get response context for TargetSummaryResource

XperiflowTimeSeriesForecastingClient​

XperiflowTimeSeriesForecastingClientFactory​

Structs​

XperiflowTimeSeriesForecastingClient.ObjectResponseResult<T>​

Interfaces​

IXperiflowTimeSeriesForecastingClient​

Last updated on by jrobinsonDSS

Was this page helpful?