diff --git a/doc/_toc.yml b/doc/_toc.yml index 516e6376..7259b037 100644 --- a/doc/_toc.yml +++ b/doc/_toc.yml @@ -18,6 +18,7 @@ parts: - file: ommx_message/function - file: ommx_message/instance - file: ommx_message/solution + - file: ommx_message/parametric_instance - caption: "OMMX Artifact" chapters: - file: ommx_artifact/architecture diff --git a/doc/ommx_message/parametric_instance.ipynb b/doc/ommx_message/parametric_instance.ipynb new file mode 100644 index 00000000..590fdc21 --- /dev/null +++ b/doc/ommx_message/parametric_instance.ipynb @@ -0,0 +1,43 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# ommx.v1.ParametricInstance\n", + "\n", + "[`ommx.v1.ParametricInstance`](https://jij-inc.github.io/ommx/python/ommx/autoapi/ommx/v1/index.html#ommx.v1.ParametricInstance) は決定変数でないパラメータを持つ数理モデルを表すデータ構造です。" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [], + "source": [ + "from ommx.v1 import Instance" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".venv", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.4" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +}