Skip to content

fix: rust doc.rs docstring build #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions binding/python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
4 changes: 2 additions & 2 deletions bintensors/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -51,4 +51,4 @@ name = "benchmark"
harness = false

[package.metadata.docs.rs]
rustdoc-args = ["--html-in-header", "../docs/katex.html"]
rustdoc-args = ["--html-in-header", "./docs/katex.html"]
File renamed without changes.
2 changes: 1 addition & 1 deletion bintensors/src/lib.rs
Original file line number Diff line number Diff line change
@@ -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)]
Expand Down
4 changes: 2 additions & 2 deletions makefile
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
Loading