Merge pull request #2 from chainyo/release-v0.0.2

release v0.0.2

README.md

@@ -35,13 +35,8 @@ __Feel free to contribute to the project by opening issues and pull requests.__
 
 ## Roadmap
 
-- [ ] Convertion from one framework to safetensors
-    * [ ] PyTorch
-    * [ ] TensorFlow
-    * [ ] JAX
-    * [ ] NumPy
-    * [ ] PadddlePaddle
-
+- [x] Convert functions from one framework to safetensors
+- [ ] Convert factory class for transparent usage
 - [ ] Pydantic schema for sharing tensors
 - [ ] Server for sharing tensors
 - [ ] Client for sharing tensors

docs/index.md

@@ -1,18 +1,42 @@
-# tensorshare
+<h1 align="center">TensorShare</h1>
 
-🤝 Trade any tensors over the network
+<div align="center">
+	<a  href="https://pypi.org/project/tensorshare" target="_blank">
+		<img src="https://img.shields.io/pypi/v/tensorshare.svg" />
+	</a>
+	<a  href="https://pypi.org/project/tensorshare" target="_blank">
+		<img src="https://img.shields.io/pypi/pyversions/tensorshare" />
+	</a>
+	<a  href="https://github.com/chainyo/tensorshare/blob/main/LICENSE" target="_blank">
+		<img src="https://img.shields.io/pypi/l/tensorshare" />
+	</a>
+	<a  href="https://github.com/chainyo/tensorshare/actions?workflow=ci-cd" target="_blank">
+		<img src="https://github.com/chainyo/tensorshare/workflows/ci-cd/badge.svg" />
+	</a>
+  <a  href="https://github.com/pypa/hatch" target="_blank">
+		<img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" />
+	</a>
+</div>
 
-__Work in progress__
+<p align="center"><em>🤝 Trade any tensors over the network</em></p>
 
-## Roadmap
+---
+
+TensorShare is a powerful tool enabling ⚡ lightning-fast tensor sharing across networks.
+
+This project leverage the best open-source tools to provide a simple and easy-to-use interface for sharing tensors:
 
-- [ ] Convertion from one framework to safetensors
-    * [ ] PyTorch
-    * [ ] TensorFlow
-    * [ ] JAX
-    * [ ] NumPy
-    * [ ] PadddlePaddle
+* [safetensors](https://github.com/huggingface/safetensors) for secure tensor serialization and deserialization.
+* [pydantic](https://github.com/pydantic/pydantic) for data validation and settings management.
+* [fastapi](https://github.com/tiangolo/fastapi) for building APIs (and because it's too good to avoid it).
+
+__This project is heavily in development and is not ready for production use.__
+__Feel free to contribute to the project by opening issues and pull requests.__
+
+## Roadmap
 
+- [x] Convert functions from one framework to safetensors
+- [ ] Convert factory class for transparent usage
 - [ ] Pydantic schema for sharing tensors
 - [ ] Server for sharing tensors
 - [ ] Client for sharing tensors

mkdocs.yml

@@ -22,11 +22,15 @@ theme:
   font:
     text: Roboto
     code: Roboto Mono
+  icon:
+    logo: material/handshake
 
 markdown_extensions:
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
 
 plugins:
   - search:

src/tensorshare/__init__.py

@@ -14,7 +14,7 @@
 """`tensorshare `: 🤝 Trade any tensors over the network"""
 
 __author__ = "Thomas Chaigneau <t.chaigneau.tc@gmail.com>"
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 
 
 from tensorshare.schema import TensorShare