YAML Schema — godml.yml

Referencia completa de todos los campos del archivo de configuración de godml.

Estructura completa

# ─── Identificación ──────────────────────────────────
name: mi-pipeline          # requerido — nombre del pipeline
version: 1.0.0             # requerido — versión semántica
provider: mlflow           # requerido — mlflow | sagemaker
description: "..."         # opcional

# ─── Dataset ─────────────────────────────────────────
dataset:
  uri: ./data/train.csv    # requerido — ruta local o s3://
  target: churned          # requerido — columna objetivo
  compliant_output: ./data/train_clean.csv  # opcional
  hash: auto               # opcional — "auto" = pendiente; usa `godml calc-hash` para calcular y fijar el valor real
  dataprep:                # opcional — receta de limpieza (requiere su propio inputs/outputs)
    inputs: [...]
    outputs: [...]
    steps: [...]

# ─── Modelo ──────────────────────────────────────────
model:
  type: xgboost            # requerido — ver tipos soportados
  source: core             # opcional — core | adhoc | local
  hyperparameters:
    max_depth: 6
    eta: 0.3
    n_estimators: 200
    objective: binary:logistic
    max_features: sqrt
    random_state: 42

# ─── Métricas ────────────────────────────────────────
metrics:
  - name: auc              # nombre de la métrica
    threshold: 0.80        # mínimo requerido para registrar el modelo
  - name: f1
    threshold: 0.70

# ─── Governance ──────────────────────────────────────
governance:
  owner: "equipo-ml"
  compliance: pci-dss      # opcional — pci-dss | null
  policy: mask_sensitive   # mask_sensitive | drop_sensitive | hash_sensitive
  tags:
    - environment: production
    - team: data-science

# ─── Deploy ──────────────────────────────────────────
deploy:
  realtime: false          # flag informativo (gobernanza); no levanta un servidor por sí solo
  batch_output: ./output/predictions.csv
  model_output: ./output/model.pkl

# ─── AWS (solo provider: sagemaker) ──────────────────
aws:
  role_arn: ${SAGEMAKER_ROLE_ARN}
  region: us-east-1
  s3_bucket: mi-bucket
  s3_prefix: godml         # default: "godml"
  kms_key_id: ${KMS_KEY_ID}  # opcional

# ─── Compute (solo provider: sagemaker) ──────────────
compute:
  preprocessing: ml.m5.large
  training: ml.m5.2xlarge
  evaluation: ml.m5.large

# ─── Model Registry (solo provider: sagemaker) ───────
registry:
  model_package_group: mi-grupo-de-modelos
  approval: manual         # manual | auto

---

Campos por sección

dataset

Campo	Tipo	Requerido	Descripción
uri	string	✅	Ruta al dataset. Local (./data/file.csv) o S3 (s3://bucket/path).
target	string	✅	Nombre de la columna objetivo.
compliant_output	string	❌	Dónde guardar el dataset después de aplicar compliance.
hash	string	❌	"auto" (default) es un placeholder — no se calcula automáticamente al correr el pipeline. Corre godml calc-hash para fijar el hash real en el YAML.
dataprep	object	❌	Receta de limpieza. Ver DataPrep.

model

Campo	Tipo	Requerido	Descripción
type	string	✅	xgboost, random_forest, logistic_regression, linear_regression, lstm_forecast (godml[deep]). lightgbm solo está soportado en el provider sagemaker, no en mlflow.
source	string	❌	core (modelos incluidos) o local (modelo personalizado en el proyecto).
hyperparameters	object	✅	Depende del tipo de modelo.

hyperparameters por tipo de modelo

logistic_regression y linear_regression pasan hyperparameters directo a sklearn.linear_model.LogisticRegression/LinearRegression — cualquier campo que esas clases no acepten (p.ej. max_depth) rompe el entrenamiento. lstm_forecast usa un set de campos completamente distinto al de los modelos de árboles.

Campo	XGBoost	RandomForest	LogisticReg	LinearReg	lstm_forecast
max_depth	✅	✅	❌	❌	❌
eta	✅	❌	❌	❌	❌
n_estimators	✅	✅	❌	❌	❌
objective	✅	❌	❌	❌	❌
max_features	❌	✅	❌	❌	❌
random_state	✅	✅	✅	❌ (no lo acepta sklearn LinearRegression)	❌
look_back	❌	❌	❌	❌	✅ (tamaño de ventana de secuencia)
units	❌	❌	❌	❌	✅ (neuronas LSTM)
learning_rate	❌	❌	❌	❌	✅
epochs	❌	❌	❌	❌	✅
batch_size	❌	❌	❌	❌	✅

governance

Campo	Valores	Descripción
compliance	pci-dss	Norma a aplicar. Enmascarado de columnas sensibles antes del entrenamiento.
policy	mask_sensitive | drop_sensitive | hash_sensitive	Qué hacer con datos sensibles.

aws (solo SageMaker)

Campo	Requerido	Descripción
role_arn	✅	ARN del IAM role con permisos de SageMaker. Soporta ${VAR}.
region	✅	Región AWS. Default: us-east-1.
s3_bucket	✅	Bucket S3 para intermedios y modelos.
s3_prefix	❌	Prefijo dentro del bucket. Default: godml.
kms_key_id	❌	Key de KMS para cifrado.

---

Variables de entorno en el YAML

Usa ${VAR_NAME} o ${VAR_NAME:default} para inyectar valores desde el entorno:

aws:
  role_arn: ${SAGEMAKER_ROLE_ARN}
  kms_key_id: ${KMS_KEY_ID:}    # vacío si no está definida

---

→ CLI Reference