欄位屬性參數

欄位屬性參數

欄位屬性(Attribute)的參數參考手冊。

參數列表

必填參數

參數類型說明
namestring欄位名稱(作為 key 時自動設定)

基本屬性

參數類型預設值說明
typestringnull資料型別:int, float, str, date, datetime
descriptionstringnull欄位說明文字
logical_typestringnull邏輯型別標註(如 email, phone

型別屬性(type_attr)

type_attr 是一個字典,包含型別相關的設定:

參數類型預設值說明
type_attr.nullablebooleantrue是否允許空值
type_attr.categorybooleanfalse是否為類別資料
type_attr.precisionintegernull數值精度(小數位數)
type_attr.formatstringnull日期時間格式字串(如 "%Y-%m-%d"
type_attr.widthintegernull字串寬度(用於前導零)
ℹ️
簡化寫法type_attr 中的參數可直接寫在屬性層級。例如 nullable: false 等同於 type_attr.nullable: false

資料處理

參數類型預設值說明
na_valueslist/stringnull自訂缺失值標記(如 "?", ["?", "N/A"]
default_valueanynull預設填充值
cast_errorsstring"coerce"型別轉換錯誤處理:"raise", "coerce", "ignore"
null_strategystring"keep"空值處理策略:"keep", "drop", "fill"

資料驗證

參數類型預設值說明
constraintsdictnull欄位約束條件(min, max, pattern

效能與統計

參數類型預設值說明
enable_optimize_typebooleantrue啟用型別優化(選擇最小資料型別)
enable_statsbooleantrue計算欄位統計資訊

系統自動生成

這些參數由系統自動設定,請勿手動設定

參數類型說明
statsFieldStats欄位統計資訊(enable_stats=True 時)
is_constantboolean標記所有值相同的欄位
created_atdatetime建立時間
updated_atdatetime更新時間

常用範例

整數欄位

age:
  type: int
  nullable: false
  description: "年齡"

類別欄位

gender:
  type: str
  category: true
  description: "性別"

浮點數(指定精度)

price:
  type: float
  precision: 2
  description: "價格(兩位小數)"

日期欄位

birth_date:
  type: date
  format: "%Y-%m-%d"
  description: "出生日期"

自訂缺失值

workclass:
  type: str
  category: true
  na_values: "?"
  description: "就業類型"

重要提醒

  • 型別簡化:使用 int, float, str, date, datetime(自動轉換舊版型別名稱)
  • 類別標記:正確設定 category: true 影響資料處理和合成策略
  • 自動推斷:未指定的參數會從資料自動推斷
  • 效能考量:大型資料集可停用 enable_stats 以提升速度