Skip to content

Commit c9b1858

Browse files
Merge pull request #32 from ivirshup/versioning
Add versioning to format
2 parents cd02796 + 8005807 commit c9b1858

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

spec/latest/index.bs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<pre class='metadata'>
2-
Title: Binary Sparse Format Specification
2+
Title: Binary Sparse Format Specification Version 0.1
33
Shortname: binsparse
44
Level: 1
55
Status: LS-COMMIT
@@ -61,6 +61,7 @@ and 12 columns, containing float32 values, along with user-defined attributes.
6161
```json
6262
{
6363
"binsparse": {
64+
"version": "0.1",
6465
"format": "CSC",
6566
"shape": [10, 12],
6667
"data_types": {
@@ -76,6 +77,14 @@ and 12 columns, containing float32 values, along with user-defined attributes.
7677

7778
</div>
7879

80+
Version {#key_version}
81+
----------------------
82+
83+
Version indicates the version of the Binsparse specification used here.
84+
This is a two digit specifier of the form `major.minor`.
85+
Any minor updates should be backwards compatible with the previous version, e.g. must be a superset of the previous versions within the major release series.
86+
Major versions may break backwards compatibility.
87+
7988
Shape {#key_shape}
8089
------------------
8190

@@ -385,6 +394,7 @@ Example of a CSR Matrix whose values are all 7.
385394

386395
```json
387396
{
397+
"version": "0.1",
388398
"format": "CSR",
389399
"shape": [5, 5],
390400
"data_types": {
@@ -521,6 +531,7 @@ Example of a symmetric CSR matrix.
521531

522532
```json
523533
{
534+
"version": "0.1",
524535
"format": "CSR",
525536
"shape": [5, 5],
526537
"structure": "symmetric_lower",

0 commit comments

Comments
 (0)