diff --git a/binding/python/pyproject.toml b/binding/python/pyproject.toml index ebeb797..826c70f 100644 --- a/binding/python/pyproject.toml +++ b/binding/python/pyproject.toml @@ -27,19 +27,7 @@ authors = [ {name = 'Luca Vivona', email = "lucavivona01@gmail.com"} ] readme = {file = "README.md", content-type = "text/markdown"} -description = """ -bintensors is a high-performance binary tensor serialization -format designed to be faster than safetensors by eliminating -JSON metadata overhead. Instead of using JSON for metadata storage, -bintensors employs a compact binary header, reducing parsing time and improving I/O efficiency. -The format begins with an 8-byte unsigned integer (u64), indicating the size of the binary header. -This header contains essential tensor metadata, including the data type (dtype), -the shape of the tensor stored as a length-prefixed list, -and data offsets specifying where each tensor's raw values are stored within the file. -An index map is also included for named tensor lookups. With its efficient structure, -bintensors provides a fast and lightweight alternative for serializing and deserializing large models, -making it ideal for machine learning, scientific computing, and other high-performance applications. -""" +description = "bintensors is a high-performance binary tensor serialization format designed to be faster than safetensors by eliminating JSON metadata overhead." [project.optional-dependencies] numpy = ["numpy>=1.21.6"] torch = [ diff --git a/bintensors/Cargo.toml b/bintensors/Cargo.toml index 73f42b7..b7b061d 100644 --- a/bintensors/Cargo.toml +++ b/bintensors/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bintensors" -version = "0.0.1-alpha.2" +version = "0.0.1-alpha.3" edition = "2024" license = "MIT" rust-version = "1.85" @@ -51,4 +51,4 @@ name = "benchmark" harness = false [package.metadata.docs.rs] -rustdoc-args = ["--html-in-header", "../docs/katex.html"] \ No newline at end of file +rustdoc-args = ["--html-in-header", "./docs/katex.html"] \ No newline at end of file diff --git a/docs/katex.html b/bintensors/docs/katex.html similarity index 100% rename from docs/katex.html rename to bintensors/docs/katex.html diff --git a/bintensors/src/lib.rs b/bintensors/src/lib.rs index 8d246e1..2a0c5a4 100644 --- a/bintensors/src/lib.rs +++ b/bintensors/src/lib.rs @@ -1,6 +1,6 @@ #![deny(missing_docs)] #![doc( - html_logo_url = "https://github.com/GnosisFoundation/bintensors/blob/master/.github/assets/bintensors-logo.png" + html_logo_url = "https://github.com/GnosisFoundation/bintensors/blob/master/.github/assets/bintensors-logo.png?raw=true" )] #![doc = include_str!("../DOC_README.md")] #![cfg_attr(not(feature = "std"), no_std)] diff --git a/makefile b/makefile index 531e6cf..228985a 100644 --- a/makefile +++ b/makefile @@ -1,8 +1,8 @@ # Define variables ROOT_DIR := $(shell pwd) -TARGET_DIR := $(ROOT_DIR)/../docs -KATEX_HEADER := $(ROOT_DIR)/docs/katex.html DOCS_DIR := $(ROOT_DIR)/bintensors +TARGET_DIR := $(DOCS_DIR)/docs +KATEX_HEADER := $(DOCS_DIR)/docs/katex.html # Ensure the target directory exists $(TARGET_DIR):