Skip to content

docs: MetricResult の docstring と仕様ドキュメントを追加 - #31

Merged
surumenDD merged 2 commits into
developfrom
docs/30-metricresult-engine-spec
Apr 10, 2026
Merged

docs: MetricResult の docstring と仕様ドキュメントを追加#31
surumenDD merged 2 commits into
developfrom
docs/30-metricresult-engine-spec

Conversation

@surumenDD

@surumenDD surumenDD commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

Closes #30

概要

MetricResult クラスの engine フィールドの値仕様が未文書化だった。バックエンド側で engine 値が "genflux" に正規化されたこと(prd-genflux-platform-backend#89)に合わせ、SDK 側のドキュメントを整備する。

変更内容

src/genflux/models/job.py

  • MetricResult の docstring に Attributes セクションを追加し、各フィールドの型・説明・engine の値仕様("genflux")を明記

docs/evaluation/EVALUATION_METRICS.md(新規作成)

  • MetricResult のフィールド一覧
  • engine フィールドの値仕様
  • 使用例コード

チェックリスト

基本

  • ruff check / ruff format をパスした
  • pyright の型チェックをパスした

公開 API の変更

  • 公開 API の変更なし(ドキュメントのみ)

ドキュメント(自動生成物 — 直接編集禁止)

  • docs/API_REFERENCE.md を直接編集していない
  • docs/DEVELOPER_API_REFERENCE.md を直接編集していない
  • llms.txt を直接編集していない
  • llms-full.txt を直接編集していない

関連 Issue

@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: baa48186-aaa8-49ba-81dc-ea1e65a5f5b0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/30-metricresult-engine-spec

Comment @coderabbitai help to get the list of available commands and usage tips.

@surumenDD

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@surumenDD
surumenDD merged commit 711c19d into develop Apr 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant