sulie下載 - sulie原始碼下載

sulie

其他源碼

1.0.0

下載

Sulie - 時間序列預測的基礎模型

Sulie 提供時間序列預測的尖端基礎模型，以最少的設定實現準確的零樣本預測。我們基於變壓器的模型使流程自動化，無需手動培訓和複雜的配置。

文件 · 回報錯誤 · 加入我們的 Slack · Twitter

特徵

零樣本預測：使用我們的基礎模型立即獲得精確的預測，無需訓練或預處理歷史資料。
自動微調：透過單一 API 呼叫增強模型效能。我們管理整個培訓流程，提供模型選擇和指標的透明度。
協變量支援（企業）：透過合併動態和靜態協變量來進行多變量預測，無需進行特徵工程。
託管基礎設施：專注於預測，因為我們無縫管理部署、擴展和維護的各個方面。
集中式資料集：透過我們的 Python SDK 持續推送時間序列數據，建立一個可在整個組織中存取的集中式版本儲存庫。

入門

要開始使用 Sulie SDK，您需要一個 API 金鑰，該金鑰可以從Sulie Dashboard產生：

造訪 Sulie 儀表板。
登入您的 Sulie 帳戶。
導航至API 金鑰部分。
產生新的 API 金鑰並將其複製以在 SDK 中使用。

準備好 API 金鑰後，您就可以開始預測了。

安裝

要安裝 Sulie SDK，只需運行：

pip install sulie==1.0.6

快速入門範例

安裝後，使用您的 API 金鑰初始化 SDK 以開始使用 Mimosa 進行預測：

 from sulie import Sulie

# Initialize the Sulie client
client = Sulie ( api_key = "YOUR_API_KEY" )

⚡️特點

1. 使用 Mimosa 進行預測

使用 Mimosa 的零樣本推理功能產生準確的時間序列預測。當您需要快速、可靠的預測而不需要訓練模型時，這種方法是理想的選擇。

 import pandas as pd

# Example time series data
df = pd . DataFrame ({
    'timestamp' : pd . date_range ( start = '2023-01-01' , periods = 1000 , freq = 'H' ),
    'demand' : [ ... ],           # Demand data
    'location' : [ 'Plant A' , ...] # Data for different locations
})

# Forecast demand for each location over the next 24 hours
forecast = client . forecast (
    dataset = df ,
    target = 'demand' ,
    group_by = 'location' ,
    date = 'timestamp' ,
    frequency = 'H' ,
    horizon = 24 ,            # Predict 24 hours ahead
    num_samples = 100        # Generate probabilistic forecasts
)
print ( forecast )

Forecast物件包括三個清單： low 、 median和high ，對應於預測中的不同確定性等級。這些可以幫助您了解可能的結果範圍，從保守到樂觀。

您也可以透過呼叫繪圖函數直接視覺化預測：

 forecast . plot ()

這可以快速產生顯示預測範圍的圖表，從而輕鬆發現結果的趨勢和變化。非常適合快速、清晰的分析。

預測參數

姓名	描述	預設
`dataset`	包含時間序列資料的`Dataset`或`pd.DataFrame` 。	必需的
`target`	預測變數的列名稱。	必需的
`group_by`	用於對資料進行分組的列名稱（例如，不同的位置）。	`None`
`date`	時間戳列名稱。	`None`
`frequency`	時間序列的頻率（例如， `H`表示每小時）。	`None`
`horizon`	提前預測的時間步驟。	`24`
`num_samples`	機率預測樣本的數量。	`100`

2. 微調客製化預測

透過自動微調，您可以針對獨特的資料集和業務案例優化 Mimosa。微調過程使用加權分位數損失（WQL）進行評估，確保高精度。

 # Fine-tune Mimosa on custom dataset
fine_tune_job = client . fine_tune (
    dataset = df ,
    target = "demand" ,
    description = "Fine-tune for Plant A demand prediction"
)

# Check the fine-tuning job status
print ( f"Job status: { fine_tune_job . status } " )

微調參數

姓名	描述	預設
`dataset`	包含時間序列資料的`Dataset`或`pd.DataFrame` 。	必需的
`target`	優化的目標變數。	必需的
`group_by`	用於對 DataFrame 系列進行分組的欄位的名稱。	`None`
`description`	微調作業的描述。	`None`

微調完成後，模型將自動部署並可用於預測。

3. 管理資料集

Sulie 的資料集 API 可讓您管理資料集並對其進行版本控制，使它們可以跨團隊進行預測和微調。

 # Upload a dataset to Sulie
dataset = client . upload_dataset (
    name = "product-sales-data-v1" ,
    df = df ,
    mode = "append"  # Choose 'append' or 'overwrite'
)

# List available datasets
datasets = client . list_datasets ()
print ( f"Available datasets: { datasets } " )

資料集管理功能

上傳：儲存資料並對其進行版本控制，以便於存取和更新。
List ：檢索已上傳資料集的清單。
更新：追加或覆蓋現有資料集的資料。

筆記

資料集是一個可選功能。要進行預測甚至微調基礎模型，您也可以將 Pandas DataFrame傳遞給forecast和fine_tune函數。

4. 使用自訂模型進行預測

可以使用list_custom_models或get_model選擇微調模型進行新預測。

 # List custom and fine-tuned models
custom_models = client . list_custom_models ()

# Select and forecast with a fine-tuned model
model_name = custom_models [ 0 ]. name
custom_model = client . get_model ( model_name )

# Forecast using the selected model
forecast_custom = custom_model . forecast (
    dataset = df ,
    target = 'demand' ,
    group_by = 'location' ,
    date = 'timestamp' ,
    frequency = 'H' ,
    horizon = 24 ,
    num_samples = 50
)
print ( forecast_custom )