開發環境
複製儲存庫並以可編輯模式安裝(推薦)
git clone https://github.com/EMI-Group/evox.git
cd evox
pip install -e ".[test]" # install the package in editable mode with test dependencies
Nix
執行以下指令以啟用 Nix 環境:
nix develop .
這將建立一個包含所有必要依賴項的 shell,以及一個包含 Python 環境的 .venv 目錄。
風格指南
EvoX 遵循以下程式碼風格指南:
- 請確保使用 ruff 來檢查您的程式碼 (lint)。
- 請確保沒有行尾空白字元 (trailing whitespaces)。
Pre-commit
我們建議使用 pre-commit 來強制執行風格指南。 安裝 pre-commit 後,請執行以下指令將 hooks 安裝到您的本機儲存庫中:
pre-commit install
執行單元測試
- 準備測試環境:在您的 Python 環境中安裝所需的套件(例如
torch) - 執行 unittest:
# run all tests
python -m unittest
# run tests in [path], e.g. python -m unittest unit_test/core/test_jit_util.py
python -m unittest [path-to-test-file]
# run a specific test method or module, e.g. python -m unittest unit_test.core.test_jit_util.TestJitUtil.test_single_eval
python -m unittest [path-to-method-or-module]