Skip to content

Repository files navigation

Binsparse: A Binary Sparse Matrix and Tensor Format Specification

Binsparse is binary storage format for storing sparse matrices and tensors to disk.

Minutes from our meetings are available here (see also: previous minutes).

Specification

View Latest Stable Spec

View Draft Spec

View All Versions

Editing

The working version of the specification can be found under spec/draft/index.bs.

The spec is written in bikeshed – a variant of markdown. To render the spec locally:

  • Install bikeshed (ideally in an isolated environment): pipx install bikeshed
  • Call bikeshed spec spec/draft/index.bs

To render the spec online, see api.csswg.org, or use the following commands:

cd binsparse-specification/spec/draft
curl https://api.csswg.org/bikeshed/ -F file=@index.bs > index.html

Rendered versions will be generated for pull requests.

Releasing

Specification releases use Semantic Versioning. Run the Release workflow from main. The workflow reads the version from the current draft, builds the specification, publishes a corresponding tag such as v0.1.0, and creates a GitHub Release containing the Bikeshed source, HTML, and PDF artifacts.

The specification's current version is defined once by the SPECVERSION Bikeshed text macro at the top of spec/draft/index.bs. Release versions must match it.

The Jekyll website renders the current draft and publishes immutable artifacts from GitHub Releases under /versions/. It links to the highest stable SemVer release, or to the draft before the first stable release exists. The website is maintained in the Binsparse/binsparse.github.io repository.

About

A cross-platform binary storage format for sparse data, particularly sparse matrices.

Resources

Stars

24 stars

Watchers

10 watching

Forks

Releases

Used by

Contributors

Languages