omni.flux.stage_manager.core#

  • SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

  • SPDX-License-Identifier: Apache-2.0

  • Licensed under the Apache License, Version 2.0 (the “License”);

  • you may not use this file except in compliance with the License.

  • You may obtain a copy of the License at

  • https://www.apache.org/licenses/LICENSE-2.0

  • Unless required by applicable law or agreed to in writing, software

  • distributed under the License 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.

class omni.flux.stage_manager.core.StageManagerCore(schema_path: str | None = None)#

Core extension used to orchestrate and manage the StageManager. The StageManagerCore relies on a StageManagerSchema to define its internal data structure.

pydantic model omni.flux.stage_manager.core.StageManagerSchema#

A Pydantic BaseModel class used to define the internal structure of the StageManager data.

This model will use the StageManager factory to resolve all the plugins and transform the JSON dict used to initialize this base model to a completely initialized data structure.

Show JSON schema
{
   "title": "StageManagerSchema",
   "type": "object",
   "properties": {
      "context": {
         "default": null,
         "title": "Context"
      },
      "interactions": {
         "default": null,
         "title": "Interactions"
      }
   }
}

Fields:

  • context (omni.flux.stage_manager.factory.plugins.context_plugin.StageManagerContextPlugin)

  • interactions (list[omni.flux.stage_manager.factory.plugins.interaction_plugin.StageManagerInteractionPlugin])

Validators:

  • check_unique_interactions » interactions

field context: StageManagerContextPlugin [Required]#

The context plugin to use to provide data

field interactions: list[StageManagerInteractionPlugin] [Required]#

List of interactions to display in the UI

Validated by:

  • check_unique_interactions

validator check_unique_interactions  »  interactions#