Add docs about object evolution in editions - #9364
Conversation
efa34d4 to
e49f7c2
Compare
e49f7c2 to
bb3f3eb
Compare
| Vortex defines an ever-growing set of serialized formats for arrays and other durable objects. | ||
| Once a format is published, every future version of Vortex can read it. **Editions** group these | ||
| formats and record when each joined that compatibility guarantee. | ||
|
|
||
| An edition member is a **serialized format**: the ID written into the file, its metadata schema, | ||
| and the meaning of its buffers, children, options, or other payload. Array and layout encodings, |
There was a problem hiding this comment.
I think we need to say that editions are a group of serde objects (array encoding, layout, ....) that are allowed to be written.
This overfits arrays.
| unrecognised encodings into inert placeholders. | ||
| Vortex defines an ever-growing set of serialized formats for arrays and other durable objects. | ||
| Once a format is published, every future version of Vortex can read it. **Editions** group these | ||
| formats and record when each joined that compatibility guarantee. |
There was a problem hiding this comment.
"hen each joined that compatibility guarantee."
should expand and talk about min required vortex (or a guess later plugin) version to read the file.
Signed-off-by: Robert Kruszewski <github@robertk.io>
bb3f3eb to
4d7d286
Compare
Merging this PR will degrade performance by 2.4%
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ❌ | WallTime | words_gather_scalar[65536] |
8.3 µs | 9.4 µs | -12.09% |
| ❌ | Simulation | take[small_m/shuffled/primitive/nonnull/chunks=16384/indices=16] |
1 ms | 1.2 ms | -11.32% |
| ⚡ | Simulation | cold_misaligned[(64, 256)] |
5.2 ms | 4.4 ms | +19.28% |
Tip
Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.
Comparing rk/editions-evolution (4d7d286) with develop (c17e058)2
Footnotes
-
89 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
-
No successful run was found on
develop(1a493b6) during the generation of this report, so c17e058 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
Describe how objects can evolve in editions and what how its going to be
enforced