[DOC] Generate gRPC API reference from the .proto files
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 50/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- grpc
- 領域
- api, documentation
調査の方向性
Start with docs/cuopt/source/cuopt-grpc/api.rst, which lists the proto paths and is missing cuopt_remote_data.proto, and with cpp/src/grpc/GRPC_INTERFACE.md for the wire-format content. Check whether the comments on ArrayFieldId and ArrayId in cpp/src/grpc/codegen/generated/cuopt_remote_data.proto are complete enough to generate from, and pick a generator such as protoc-gen-doc for the docs build. Done means reference pages exist for the five .proto files, api.rst links them with :download: links to the protos, and GRPC_INTERFACE.md is included or linked.
索引モデルが issue の本文から書いたものです。
説明
Problem
Anyone writing their own client for cuopt_grpc_server has to work from the .proto files, but the published docs don't carry them:
docs/cuopt/source/cuopt-grpc/api.rstlists four repo paths as plain text. There are no links, downloads or includes.cuopt_remote_data.proto, which holds the actual LP/MIP/QP problem fields, is not listed. It is generated fromcpp/src/grpc/codegen/field_registry.yamland committed undercpp/src/grpc/codegen/generated/.- The element layout and dtype of each array is documented only in comments on
ArrayFieldIdand the nestedArrayIdenums. The docs don't show those comments. - The chunked-transfer wire format (raw native-endian bytes,
container_field_num/container_index, NUL-joined string blobs, message-size limits) is incpp/src/grpc/GRPC_INTERFACE.md, which the published docs don't include or link to. - The protos are not in the
libcuopt-clientwheel I checked, so users must find them in git at the matching release.
Proposal
Generate reference pages from the protos during the docs build, for example with protoc-gen-doc. The field comments then flow into the docs and can't drift from the code.
- Generate pages for
cuopt_remote_service.proto,cuopt_remote.proto,cuopt_remote_data.proto,cuopt_routing.protoandcuopt_routing_solution.proto. - Link them from
cuopt-grpc/api.rst, and add:download:links to the.protofiles. - Bring the content of
GRPC_INTERFACE.mdinto the docs, or link to it. - Fix the file-name list in
api.rstso it includescuopt_remote_data.proto.
Notes
- Check that the proto comments are complete enough to serve as the reference. The generated pages are only as good as those comments.
- Shipping the protos with a release package and adding server reflection are separate options and are not part of this issue.
- 主要言語
- Cuda
- スター
- 1.1k
- フォーク
- 255
- 平均マージ
- 1日 11時間
- マージ済み PR（30日）
- 123
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NVIDIA/cuopt のほかの issue
-
[BUG] Constraint validation reports CSR offset count as the number of rows対応中かも @0z5a が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
ci: pr-test-summary job shows red when the GitHub API returns persistent 5xx errors対応中かも @0z5a が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
[BUG] Dataset downloader reports success and replaces data after a failed download対応中かも @0z5a が 2 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
NethermindEth/nethermind#15684 ·
メンテナーはふだん 1 日以内に返信
-
bug(bufdelete): all()/other() abort with "Invalid buffer id" when a buffer is wiped during the loopオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
folke/snacks.nvim#2986 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
OCA/l10n-brazil#5602 ·
メンテナーはふだん 1 日以内に返信
-
documentation review-2.0.0
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
dkuenzel/meshcore-home-gateway#98 ·
メンテナーはふだん 1 日以内に返信
-
mp4box.js — 20-byte `sgpd` box with large `entry_count` causes unbounded loop and heap OOM abortオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信