Skip to content

Commit dcf593f

Browse files
committed
Schema breakage
1 parent 69b955d commit dcf593f

4 files changed

Lines changed: 57 additions & 1 deletion

File tree

docs/en/releases/unreleased.ipynb

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/ja/releases/unreleased.ipynb

Lines changed: 17 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

markdowns/en/releases/unreleased.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ If you have been avoiding dictionaries because of performance concerns, this is
2424

2525
+++
2626

27+
## Breaking Changes
28+
29+
### Protobuf schema changes
30+
31+
JijModeling 2.4.0 brings the breaking changes to the Protobuf schema for {py:class}`~jijmodeling.Problem`.
32+
As a result, Problems serialized to Protobuf with version 2.4.0 or later can no longer be loaded by JijModeling versions 2.3.x or earlier.
33+
On the other hand, Problems serialized with versions 2.3.x or earlier can be loaded by JijModeling versions 2.4.0 or later.
34+
This may affect data storage and exchange through MINTO, but in that case, updating the dependent JijModeling version to 2.4.0 or later will allow both existing and new data to be loaded without issue.
35+
Also, this only affects direct use of JijModeling's Protobuf schema; there is no particular impact on the OMMX format.
36+
37+
+++
38+
2739
## Feature Enhancements
2840

2941
+++

markdowns/ja/releases/unreleased.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ kernelspec:
2222
辞書の内部処理を改善し、旧来に比べ約 30 倍の大幅な性能改善を実現しました!
2323
パフォーマンス上の懸念から辞書を避けていた場合、ぜひこの機会に辞書を活用してみてください。
2424

25+
+++
26+
27+
## 破壊的変更
28+
29+
### Protobuf スキーマの変更
30+
31+
JijModeling 2.4.0 では {py:class}`~jijmodeling.Problem` の Protobuf スキーマが破壊的に変更されました。
32+
これにより、2.4.0 以降で Protobuf にシリアライズされた Problem は、2.3.x 以前のバージョンの JijModeling では読み込めなくなります。
33+
一方で、2.3.x 以前のバージョンでシリアライズされた Problem は、2.4.0 以降のバージョンの JijModeling で読み込むことができます。
34+
これは、MINTO によるデータ保存・交換時に影響が出る可能性がありますが、その場合は依存する JijModeling のバージョンを 2.4.0 以降に更新することで、既存のデータも、新しいデータも問題なく読めるようになります。
35+
また、影響を受けるのは JijModeling の Protobuf スキーマを直接利用している場合であり、OMMX 形式に関しては特に影響はありません。
36+
2537
## 機能強化
2638

2739
+++

0 commit comments

Comments
 (0)