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.

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

Enhance Documentation for docs/en/tutorial/tsp_sampling_with_openjij_adapter.ipynb #295

Merged
merged 5 commits into from
Feb 14, 2025

Conversation

ahao27
Copy link
Contributor

@ahao27 ahao27 commented Feb 5, 2025

Summary

This pull request updates the tutorial to explain and guide how to solve TSP via ommx.

Changes

The file docs/en/tutorial/tsp_sampling_with_openjij_adapter.ipynb.

@Shitaro Shitaro self-assigned this Feb 6, 2025
@Shitaro Shitaro self-requested a review February 6, 2025 05:23
@Shitaro Shitaro removed their assignment Feb 6, 2025
@Shitaro Shitaro added the documentation Improvements or additions to documentation label Feb 6, 2025
@Shitaro
Copy link
Member

Shitaro commented Feb 6, 2025

Hi, @ahao27

There is a conflict because the content in tsp_sampling_with_openjij_adapter.ipynb has been changed.

The updated machine translation that has been merged into the main branch (see: https://github.com/Jij-Inc/ommx/blob/2e9009780e7c9a8af5678855a48dccbbada7582c/docs/en/tutorial/tsp_sampling_with_openjij_adapter.ipynb) is as follows:

"ommx_openjij_adapter.sample_qubo_sa returns ommx.v1.Samples, which can be passed to Instance.evaluate_samples to calculate the objective function values and constraint violations. The SampleSet.summary property is used to display summary information. feasible indicates the feasibility with respect to the original problem before conversion to QUBO. This is calculated using the information stored in removed_constraints of the qubo instance."

image

For your reference, the corresponding Japanese is (see: https://github.com/Jij-Inc/ommx/blob/2e9009780e7c9a8af5678855a48dccbbada7582c/docs/ja/tutorial/tsp_sampling_with_openjij_adapter.ipynb):
「ommx_openjij_adapter.sample_qubo_sa は ommx.v1.Samples を返し、これを Instance.evaluate_samples に渡すことで目的関数の値や制約条件の破れを計算できます。SampleSet.summary プロパティはこれらの要約情報を表示するためのものです。feasible はQUBOに変換する前の、元の問題に対する実行可能性を示しています。これは qubo インスタンスの removed_constraints に格納されている情報を使って計算されます。」
image

Please check the machine translation in the main branch.

Thank you!

Copy link
Member

@Shitaro Shitaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thx

@termoshtt termoshtt merged commit b61bf0c into main Feb 14, 2025
32 checks passed
@termoshtt termoshtt deleted the docs/en/tutorial/tsp_sampling_with_openjij_adapter branch February 14, 2025 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants