快速入門

本指南將協助您開始使用 FinOL。

命令行使用方法

為了降低研究人員的使用門檻，FinOL 提供了一站式解決方案，僅需 3 行命令即可完成數據加載、模型訓練和測試。

>>> from finol.data_layer.dataset_loader import DatasetLoader
>>> from finol.optimization_layer.model_trainer import ModelTrainer
>>> from finol.evaluation_layer.model_evaluator import ModelEvaluator


>>> load_dataset_output = DatasetLoader().load_dataset()
>>> train_model_output = ModelTrainer(load_dataset_output).train_model()
>>> evaluate_model_output = ModelEvaluator(load_dataset_output, train_model_output).evaluate_model()

在執行上述命令之前，用戶可以先透過配置文件設置一些參數，以根據自己的需求進行定制。例如設置使用的設備、選擇數據集、調整數據預處理參數以及選擇模型等。具體的配置方法如下:

>>> from finol.utils import load_config, update_config

>>> config = load_config()
>>> config["DEVICE"] = "auto"
>>> config["DOWNLOAD_DATA"] = True
>>> config["DATASET_NAME"] = "DJIA"
>>> config["DATA_AUGMENTATION_CONFIG"]["WINDOW_DATA"]["WINDOW_SIZE"] = 5
>>> config["DATA_AUGMENTATION_CONFIG"]["IMAGE_DATA"]["INCLUDE_IMAGE_DATA"] = False
>>> config["SCALER"] = "WindowMinMaxScaler"
>>> config["MODEL_NAME"] = "DNN"
>>> config["TUNE_PARAMETERS"] = True  # False
>>> update_config(config)
>>> config

圖形界面使用方法

除了命令行使用方式外，FinOL 還提供了一個圖形界面（GUI），讓用戶可以以更直觀和可視化的方式實現與命令行相同的功能。這個圖形界面包括數據集選擇、模型配置、訓練和評估等選項，讓用戶可以輕鬆自定義參數並運行實驗，無需編寫任何代碼。

要訪問 FinOL 圖形界面，可以在終端運行以下命令：

$ python -m finol.APP.FinOLAPP

FinOL 圖形界面的總體框架

圖形界面分為三個主要部分：

1. 側邊欄

該區域位於左側，包含用於自定義數據集、模型和評判標準等操作的各種按鈕。它還包括加載數據集、訓練模型、評估模型、退出圖形界面和重啓圖形界面的選項。

FinOL 圖形界面的側邊欄

2. 選項卡視圖

該區域位於右上方，允許用戶在不同的配置層之間切換，例如數據層、模型層、優化層和評估層。每個選項卡都提供了用於配置各自層的特定設置和選項，包括設備和數據集選擇、特徵包含和數據增強參數。

FinOL 圖形界面的選項卡視圖

3. 輸出顯示

該區域位於右下方，專門用於顯示內部輸出，如基準測試結果。

FinOL 圖形界面的輸出顯示

透過使用 FinOL 圖形界面，用戶可以快速輕鬆地配置，訓練和評估金融模型，而無需編寫複雜的代碼。直觀的界面使研究人員更容易使用和操作。

FinOL 圖形界面的獨特之處

除了上述功能外，FinOL 圖形界面還具有一些獨特的交互功能，可以增強用戶體驗。

1. 動態窗口佈局

FinOL 的圖形界面採用了動態佈局設計，根據用戶的選擇和設置，相應的配置窗口會動態變化。

FinOL 圖形界面的動態窗口佈局

例如，當用戶在」模型層」中選擇不同的模型架構時，相應的配置選項框就會自動變化，展示出該模型特有的參數設置項。這種動態變化的佈局，可以讓用戶更專注地配置模型，而不需要在不同的選項卡或窗口之間來回切換。

2. 實時配置文件更新

FinOL 的圖形界面不僅提供直觀的配置設置，而且可以實時將用戶的設置更新到根目錄下的 config.json 文件中。

每當用戶在圖形界面中修改任何參數，配置文件都會被自動更新，以反映最新的設置。這種實時讀寫配置文件的功能，為用戶提供了一種無縫的工作流，允許用戶在圖形用戶界面和命令行界面之間切換，而不會出現任何不一致。

FinOL 圖形界面的實時配置文件更新

無論是透過圖形界面還是命令行，用戶都可以獲得完全一致的運行環境和參數設置，這大大提高了靈活性和可維護性。