Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename to "OMMX Solver Adapter" #268

Merged
merged 1 commit into from
Jan 20, 2025
Merged

Rename to "OMMX Solver Adapter" #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/_toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ parts:
- caption: "OMMX Ecosystem"
chapters:
- file: ommx_ecosystem/links
- file: ommx_ecosystem/adapter
- file: ommx_ecosystem/solver_adapter_guide
- caption: "API Reference"
chapters:
- url: https://jij-inc.github.io/ommx/protobuf.html
Expand Down
12 changes: 8 additions & 4 deletions doc/ommx_ecosystem/adapter.ipynb → ...ommx_ecosystem/solver_adapter_guide.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@
"id": "b578922f-02f2-4169-b16b-d3b5db062d40",
"metadata": {},
"source": [
"# OMMX Adapter実装ガイド\n",
"# OMMX Solver Adapter実装ガイド\n",
"\n",
"本ドキュメントは、OMMXからSolverを実行するためのAdapterを実装する際の推奨事項を記載したものである。下記の内容に従いOMMX Adapterを実装することで、他のOMMX Adapterと一定程度の一貫性を保つことができ、複数のOMMX Adapterを利用するユーザーにとってよりよいユーザー体験の提供に繋がる。そのため、OMMXコミュニティとしては以下の内容に従うことを推奨したい。\n",
"```{note}\n",
"現在、OMMXからSamplerを実行するためのAdapter（OMMX Sampler Adapter）に関する実装ガイドも準備中です。\n",
"```\n",
"\n",
"本ドキュメントは、OMMXからSolverを実行するためのAdapter（以下、OMMX Solver Adapterと呼ぶ）を実装する際の推奨事項を記載したものである。下記の内容に従いOMMX Solver Adapterを実装することで、他のOMMX Solver Adapterと一定程度の一貫性を保つことができ、複数のOMMX Solver Adapterを利用するユーザーにとってよりよいユーザー体験の提供に繋がる。そのため、OMMXコミュニティとしては以下の内容に従うことを推奨したい。\n",
"\n",
"## 推奨事項\n",
"\n",
Expand Down Expand Up @@ -70,9 +74,9 @@
" ```\n",
" \n",
"\n",
"## 推奨事項を満たすOMMX Adapterが保証するユーザー体験\n",
"## 推奨事項を満たすOMMX Solver Adapterが保証するユーザー体験\n",
"\n",
"上記の推奨事項を満たすOMMX Adapterは、以下の一貫したユーザー体験を与えることができる。\n",
"上記の推奨事項を満たすOMMX Solver Adapterは、以下の一貫したユーザー体験を与えることができる。\n",
"\n",
"- Solverを気軽に利用したいユーザー（Solverの入出力方法やパラメーターを把握したくないユーザー）は、共通で提供されている静的メソッド `solve` で簡単にSolverを実行できる\n",
" \n",
Expand Down
Loading