Skip to content

Commit

Permalink
Merge pull request #32 from ivirshup/versioning
Browse files Browse the repository at this point in the history
Add versioning to format
  • Loading branch information
willow-ahrens authored Sep 14, 2023
2 parents cd02796 + 8005807 commit c9b1858
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion spec/latest/index.bs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<pre class='metadata'>
Title: Binary Sparse Format Specification
Title: Binary Sparse Format Specification Version 0.1
Shortname: binsparse
Level: 1
Status: LS-COMMIT
Expand Down Expand Up @@ -61,6 +61,7 @@ and 12 columns, containing float32 values, along with user-defined attributes.
```json
{
"binsparse": {
"version": "0.1",
"format": "CSC",
"shape": [10, 12],
"data_types": {
Expand All @@ -76,6 +77,14 @@ and 12 columns, containing float32 values, along with user-defined attributes.

</div>

Version {#key_version}
----------------------

Version indicates the version of the Binsparse specification used here.
This is a two digit specifier of the form `major.minor`.
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.
Major versions may break backwards compatibility.

Shape {#key_shape}
------------------

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

```json
{
"version": "0.1",
"format": "CSR",
"shape": [5, 5],
"data_types": {
Expand Down Expand Up @@ -521,6 +531,7 @@ Example of a symmetric CSR matrix.

```json
{
"version": "0.1",
"format": "CSR",
"shape": [5, 5],
"structure": "symmetric_lower",
Expand Down

0 comments on commit c9b1858

Please sign in to comment.