oracle-ads 2.13.7__py3-none-any.whl → 2.13.9rc0__py3-none-any.whl

ads/opctl/operator/lowcode/forecast/schema.yaml

@@ -1,506 +0,0 @@
-kind:
-  allowed:
-    - operator
-  required: true
-  type: string
-  default: operator
-  meta:
-    description: "Which service are you trying to use? Common kinds: `operator`, `job`"
-
-version:
-  allowed:
-    - "v1"
-  required: true
-  type: string
-  default: v1
-  meta:
-    description: "Operators may change yaml file schemas from version to version, as well as implementation details. Double check the version to ensure compatibility."
-
-type:
-  required: true
-  type: string
-  default: forecast
-  meta:
-    description: "Type should always be `forecast` when using a forecast operator"
-
-spec:
-  required: true
-  schema:
-    historical_data:
-      required: true
-      type: dict
-      default: {"url": "data.csv"}
-      meta:
-        description: "This should be indexed by date and target category (optionally). It should include all targets and endogeneous data."
-      schema:
-        connect_args:
-          nullable: true
-          required: false
-          type: dict
-        data:
-          nullable: true
-          required: false
-        format:
-          allowed:
-            - csv
-            - json
-            - clipboard
-            - excel
-            - feather
-            - sql_table
-            - sql_query
-            - hdf
-            - tsv
-            - pandas
-          required: false
-          type: string
-        columns:
-          required: false
-          type: list
-          schema:
-            type: string
-        filters:
-          required: false
-          type: list
-          schema:
-            type: string
-        options:
-          nullable: true
-          required: false
-          type: dict
-        sql:
-          required: false
-          type: string
-        table_name:
-          required: false
-          type: string
-        url:
-          required: false
-          type: string
-          meta:
-            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
-        limit:
-          required: false
-          type: integer
-        vault_secret_id:
-          required: false
-          type: string
-
-    additional_data:
-      required: false
-      type: dict
-      meta:
-        description: "Additional datasets must be indexed by the same targets and target categories as the historical data. Also is must have datapoints for each date/category for your horizon. This must be exogeneous data."
-      schema:
-        connect_args:
-          nullable: true
-          required: false
-          type: dict
-        data:
-          nullable: true
-          required: false
-        format:
-          allowed:
-            - csv
-            - json
-            - clipboard
-            - excel
-            - feather
-            - sql_table
-            - sql_query
-            - hdf
-            - tsv
-            - pandas
-          required: false
-          type: string
-        columns:
-          required: false
-          type: list
-          schema:
-            type: string
-        filters:
-          required: false
-          type: list
-          schema:
-            type: string
-        options:
-          nullable: true
-          required: false
-          type: dict
-        sql:
-          required: false
-          type: string
-        table_name:
-          required: false
-          type: string
-        url:
-          required: false
-          type: string
-          meta:
-            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
-        limit:
-          required: false
-          type: integer
-        vault_secret_id:
-          required: false
-          type: string
-
-    test_data:
-      required: false
-      meta:
-        description: "Optional, only if evaluation is needed."
-      schema:
-        connect_args:
-          nullable: true
-          required: false
-          type: dict
-        data:
-          nullable: true
-          required: false
-        format:
-          allowed:
-            - csv
-            - json
-            - clipboard
-            - excel
-            - feather
-            - sql_table
-            - sql_query
-            - hdf
-            - tsv
-            - pandas
-          required: false
-          type: string
-        columns:
-          required: false
-          type: list
-          schema:
-            type: string
-        filters:
-          required: false
-          type: list
-          schema:
-            type: string
-        options:
-          nullable: true
-          required: false
-          type: dict
-        sql:
-          required: false
-          type: string
-        table_name:
-          required: false
-          type: string
-        url:
-          required: false
-          type: string
-          meta:
-            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
-        limit:
-          required: false
-          type: integer
-        vault_secret_id:
-          required: false
-          type: string
-      type: dict
-
-    output_directory:
-      required: false
-      schema:
-        connect_args:
-          nullable: true
-          required: false
-          type: dict
-        format:
-          allowed:
-            - csv
-            - json
-            - clipboard
-            - excel
-            - feather
-            - sql_table
-            - sql_query
-            - hdf
-            - tsv
-          required: false
-          type: string
-        columns:
-          required: false
-          type: list
-          schema:
-            type: string
-        filters:
-          required: false
-          type: list
-          schema:
-            type: string
-        options:
-          nullable: true
-          required: false
-          type: dict
-        sql:
-          required: false
-          type: string
-        table_name:
-          required: false
-          type: string
-        url:
-          required: false
-          type: string
-          meta:
-            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
-        limit:
-          required: false
-          type: integer
-      type: dict
-
-    report_filename:
-      required: false
-      type: string
-      default: report.html
-      meta:
-        description: "Placed into output_directory location. Defaults to report.html"
-    report_title:
-      required: false
-      type: string
-    report_theme:
-      required: false
-      type: string
-      default: light
-      allowed:
-        - light
-        - dark
-    metrics_filename:
-      required: false
-      type: string
-      default: metrics.csv
-      meta:
-        description: "Placed into output_directory location. Defaults to metrics.csv"
-    test_metrics_filename:
-      required: false
-      type: string
-      default: test_metrics.csv
-      meta:
-        description: "Placed into output_directory location. Defaults to test_metrics.csv"
-    forecast_filename:
-      required: false
-      type: string
-      default: forecast.csv
-      meta:
-        description: "Placed into output_directory location. Defaults to forecast.csv"
-    global_explanation_filename:
-      required: false
-      type: string
-      default: global_explanations.csv
-      meta:
-        description: "Placed into output_directory location. Defaults to global_explanations.csv"
-    local_explanation_filename:
-      required: false
-      type: string
-      default: local_explanations.csv
-      meta:
-        description: "Placed into output_directory location. Defaults to local_explanations.csv"
-
-    target_column:
-      type: string
-      required: true
-      default: target
-
-    preprocessing:
-      type: dict
-      required: false
-      schema:
-        enabled:
-          type: boolean
-          required: false
-          default: true
-          meta:
-            description: "preprocessing and feature engineering can be disabled using this flag, Defaults to true"
-        steps:
-          type: dict
-          required: false
-          schema:
-            missing_value_imputation:
-              type: boolean
-              required: false
-              default: true
-            outlier_treatment:
-              type: boolean
-              required: false
-              default: false
-
-    generate_explanations:
-      type: boolean
-      required: false
-      default: false
-      meta:
-        description: "Explainability, both local and global, can be disabled using this flag. Defaults to false."
-
-    explanations_accuracy_mode:
-      type: string
-      required: false
-      default: FAST_APPROXIMATE
-      allowed:
-        - HIGH_ACCURACY
-        - BALANCED
-        - FAST_APPROXIMATE
-        - AUTOMLX
-
-    generate_report:
-      type: boolean
-      required: false
-      default: true
-      meta:
-        description: "Report file generation can be enabled using this flag. Defaults to true."
-
-    what_if_analysis:
-      type: dict
-      required: false
-      schema:
-        model_deployment:
-          type: dict
-          required: false
-          meta: "If model_deployment id is not specified, a new model deployment is created; otherwise, the model is linked to the specified model deployment."
-          schema:
-            id:
-              type: string
-              required: false
-            display_name:
-              type: string
-              required: false
-            initial_shape:
-              type: string
-              required: false
-            description:
-              type: string
-              required: false
-            log_group:
-              type: string
-              required: true
-            log_id:
-              type: string
-              required: false
-            auto_scaling:
-              type: dict
-              required: false
-              schema:
-                minimum_instance:
-                  type: integer
-                  required: true
-                maximum_instance:
-                  type: integer
-                  required: true
-                scale_in_threshold:
-                  type: integer
-                  required: true
-                scale_out_threshold:
-                  type: integer
-                  required: true
-                scaling_metric:
-                  type: string
-                  required: true
-                cool_down_in_seconds:
-                  type: integer
-                  required: true
-        model_display_name:
-          type: string
-          required: true
-        project_id:
-          type: string
-          required: false
-          meta: "If not provided, The project OCID from config.PROJECT_OCID is used"
-        compartment_id:
-          type: string
-          required: false
-          meta: "If not provided, The compartment OCID from config.NB_SESSION_COMPARTMENT_OCID is used."
-      meta:
-        description: "When enabled, the models are saved to the model catalog. Defaults to false."
-
-    generate_metrics:
-      type: boolean
-      required: false
-      default: true
-      meta:
-        description: "Metrics files generation can be enabled using this flag. Defaults to true."
-
-    datetime_column:
-      type: dict
-      required: true
-      schema:
-        name:
-          type: string
-          required: true
-          default: Date
-        format:
-          type: string
-          required: false
-
-    target_category_columns:
-      type: list
-      required: false
-      schema:
-        type: string
-      default: ["Series ID"]
-
-    horizon:
-      required: true
-      type: integer
-      default: 1
-
-    model:
-      type: string
-      required: false
-      default: prophet
-      allowed:
-        - prophet
-        - arima
-        - neuralprophet
-        # - lgbforecast
-        - automlx
-        - autots
-        - auto-select
-
-    model_kwargs:
-      type: dict
-      required: false
-
-    previous_output_dir:
-      type: string
-      required: false
-
-    generate_model_parameters:
-      type: boolean
-      required: false
-
-    generate_model_pickle:
-      type: boolean
-      required: false
-
-    confidence_interval_width:
-      type: float
-      required: false
-      default: 0.80
-
-    tuning:
-      type: dict
-      required: false
-      schema:
-        n_trials:
-          type: integer
-          required: false
-          default: 10
-
-    metric:
-      type: string
-      required: false
-      default: MAPE
-      allowed:
-        - MAPE
-        - RMSE
-        - MSE
-        - SMAPE
-        - mape
-        - rmse
-        - mse
-        - smape
-  type: dict