docs: MetricResult の docstring と仕様ドキュメントを追加 - #31
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
Closes #30
概要
MetricResultクラスのengineフィールドの値仕様が未文書化だった。バックエンド側で engine 値が"genflux"に正規化されたこと(prd-genflux-platform-backend#89)に合わせ、SDK 側のドキュメントを整備する。変更内容
src/genflux/models/job.pyMetricResultの docstring に Attributes セクションを追加し、各フィールドの型・説明・engineの値仕様("genflux")を明記docs/evaluation/EVALUATION_METRICS.md(新規作成)MetricResultのフィールド一覧engineフィールドの値仕様チェックリスト
基本
ruff check/ruff formatをパスしたpyrightの型チェックをパスした公開 API の変更
ドキュメント(自動生成物 — 直接編集禁止)
docs/API_REFERENCE.mdを直接編集していないdocs/DEVELOPER_API_REFERENCE.mdを直接編集していないllms.txtを直接編集していないllms-full.txtを直接編集していない関連 Issue