Docs /Templates/ sinapsis-data-analysis

XGBoostInference

sinapsis-data-analysisXGBoostxgboostinferencesklearnprediction

Python template · sinapsis_data_analysis.templates.inference.xgboost_inference

Overview

Dynamic templates to perform inference using XGBoost models. These templates wrap the functionality of the xgb module and use the predict method on execute using a dataset obtained through the container.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-data-analysis==1.0.0
uv pip install sinapsis-data-analysis==1.0.0
uv add sinapsis-data-analysis==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
root_dir
str
Optional
Default: "/sinapsis-hub/private/platform/sinapsis-hub/playground"
model_pathRequired

Path to the saved model file.

str
Required
Default: null
target_keyRequired
str
Required
Default: null
generic_field_keyRequired

Key of the generic field where data is stored.

str
Required
Default: null

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "XGBoostInference"
    class_name: "XGBoostInference"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground"
      model_path: "<required>"
      target_key: "<required>"
      generic_field_key: "<required>"
View original docstring example

The source example references XGBRFClassifierInference, not XGBoostInference.

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: XGBRFClassifierInference
  class_name: XGBRFClassifierInference
  template_input: InputTemplate
  attributes:
    model_path: 'artifacts/xgb_rf_classifier.model'
    generic_field_key: 'generic_dataset'

Inheritance

Immediate parent: sinapsis_data_analysis.templates.inference.sklearn_inference.SKLearnInference

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.