lopace 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

lopace/__init__.py

@@ -7,5 +7,9 @@ using multiple techniques: Zstd, Token-based (BPE), and Hybrid methods.
 
 from .compressor import PromptCompressor, CompressionMethod
 
-__version__ = "0.1.0"
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "0.0.0.dev0+unknown"
+
 __all__ = ["PromptCompressor", "CompressionMethod"]

lopace/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.5'
+__version_tuple__ = version_tuple = (0, 1, 5)
+
+__commit_id__ = commit_id = None

{lopace-0.1.3.dist-info → lopace-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lopace
-Version: 0.1.3
+Version: 0.1.5
 Summary: Lossless Optimized Prompt Accurate Compression Engine
 Home-page: https://github.com/connectaman/LoPace
 Author: Aman Ulla
@@ -34,7 +34,7 @@ Dynamic: requires-python
 # LoPace
 
 <div align="center">
-  <img src="screenshots/logo-text.png" alt="LoPace Logo" width="600"/>
+  <img src="https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/logo-text.png" alt="LoPace Logo" width="600"/>
 </div>
 
 **Lossless Optimized Prompt Accurate Compression Engine**
@@ -45,6 +45,14 @@ A professional, open-source Python package for compressing and decompressing pro
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
 [![PyPI version](https://badge.fury.io/py/lopace.svg)](https://pypi.org/project/lopace/)
 [![🤗 Spaces](https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/codewithaman/LoPace)
+[![arXiv](https://img.shields.io/badge/arXiv-Paper-b31b1b.svg)](https://raw.githubusercontent.com/connectaman/LoPace/main/paper/lopace-preprint-arxiv.pdf)
+
+<div align="center">
+  <a href="https://raw.githubusercontent.com/connectaman/LoPace/main/paper/lopace-preprint-arxiv.pdf">
+    <img src="https://raw.githubusercontent.com/connectaman/LoPace/main/paper/lopace-preprint-arxiv-01.png" alt="LoPace Research Paper - First Page" width="250" style="cursor: pointer; border: 1px solid #ddd; border-radius: 4px;">
+  </a>
+  <p><em>Click the image above to view the full research paper (PDF)</em></p>
+</div>
 
 ## The Problem: Storage Challenges with Large Prompts
 
@@ -263,7 +271,7 @@ Enumeration of available compression methods:
 
 ### Compression Pipeline (Hybrid Method)
 
-![Compression Pipeline](screenshots/compression-pipeline.png)
+![Compression Pipeline](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/compression-pipeline.png)
 
 ### Why Hybrid is Best for Databases
 
@@ -287,7 +295,7 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Compression Ratio Analysis
 
-![Compression Ratio](screenshots/compression_ratio.svg)
+![Compression Ratio](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/compression_ratio.svg)
 
 **Key Insights:**
 - **Hybrid method consistently achieves the highest compression ratios** across all prompt sizes
@@ -297,7 +305,7 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Space Savings Performance
 
-![Space Savings](screenshots/space_savings.svg)
+![Space Savings](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/space_savings.svg)
 
 **Key Insights:**
 - **Hybrid method achieves 70-80% space savings** on average across all prompt categories
@@ -307,7 +315,7 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Disk Size Comparison
 
-![Disk Size Comparison](screenshots/disk_size_comparison.svg)
+![Disk Size Comparison](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/disk_size_comparison.svg)
 
 **Key Insights:**
 - **Dramatic reduction in storage requirements** - compressed data is 3-6x smaller than original
@@ -317,8 +325,8 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Speed & Throughput Metrics
 
-![Speed Metrics](screenshots/speed_metrics.svg)
-![Speed Metrics](screenshots/original_vs_decompressed.svg)
+![Speed Metrics](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/speed_metrics.svg)
+![Speed Metrics](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/original_vs_decompressed.svg)
 
 **Key Insights:**
 - **Compression speeds range from 50-200 MB/s** depending on method and prompt size
@@ -328,7 +336,7 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Memory Usage Analysis
 
-![Memory Usage](screenshots/memory_usage.svg)
+![Memory Usage](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/memory_usage.svg)
 
 **Key Insights:**
 - **Memory footprint is minimal** - typically under 10 MB even for large prompts
@@ -338,7 +346,7 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Comprehensive Method Comparison
 
-![Comprehensive Comparison](screenshots/comprehensive_comparison.svg)
+![Comprehensive Comparison](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/comprehensive_comparison.svg)
 
 **Key Insights:**
 - **Heatmaps provide at-a-glance comparison** of all metrics across methods and prompt sizes
@@ -348,7 +356,7 @@ Comprehensive benchmarks were conducted on 10 diverse prompts across three size
 
 ### Scalability Analysis
 
-![Scalability Analysis](screenshots/scalability_analysis.svg)
+![Scalability Analysis](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/scalability_analysis.svg)
 
 **Key Insights:**
 - **Performance scales efficiently** with prompt size across all metrics
@@ -418,6 +426,23 @@ cd lopace
 pip install -r requirements-dev.txt
 ```
 
+### Versioning & Releasing
+
+LoPace uses [setuptools-scm](https://github.com/pypa/setuptools_scm) so the package version is **derived from Git tags** — no manual edits to `setup.py` or `pyproject.toml` are needed.
+
+**To release a new version:**
+
+1. Bump the version by creating and pushing a tag (e.g. `v0.1.5`):
+   ```bash
+   git tag v0.1.5
+   git push origin v0.1.5
+   ```
+2. CI builds the package with that version and publishes to PyPI.
+
+The version in `lopace.__version__` (and the built distribution) comes from the latest tag. Without a tag, you get a dev version like `0.1.5.dev3+gabc1234`.
+
+**Will the next push to `main` build 0.1.4?** No. If the latest tag is `v0.1.4` and you push new commits to `main` without a new tag, setuptools-scm produces a **development version** (e.g. `0.1.5.dev3`), not `0.1.4`. To release `0.1.5`, create and push the tag `v0.1.5`; CI will then build and publish that version to PyPI.
+
 ### Running Tests
 
 ```bash
@@ -441,7 +466,7 @@ See [.github/workflows/README.md](.github/workflows/README.md) for detailed setu
 
 LoPace uses the following compression techniques:
 
-![Compression techniques](screenshots/lopace-compression-technique.png)
+![Compression techniques](https://raw.githubusercontent.com/connectaman/LoPace/main/screenshots/lopace-compression-technique.png)
 
 1. **LZ77 (Sliding Window)**: Used **indirectly** through Zstandard
    - Zstandard internally uses LZ77-style algorithms to find repeated patterns

lopace-0.1.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+lopace/__init__.py,sha256=1X75FQdnzJaDueL_xRGTBn3vvIAXR1T_siSA_mW391E,443
+lopace/_version.py,sha256=rdxBMYpwzYxiWk08QbPLHSAxHoDfeKWwyaJIAM0lSic,704
+lopace/compressor.py,sha256=nUTWDcAPYvQaeSFKx_lne-D2xIQ02IMVGE4yLODo8qE,19060
+lopace-0.1.5.dist-info/licenses/LICENSE,sha256=uFUrlsfsOwx_8Nzhq2pUgNaJghcJxXBMML3l7T39Tm0,1067
+scripts/README.md,sha256=UEsrHKKfiEixTMtWV8trYBKnzgkImJxxEnXTyDI4r9g,2226
+scripts/__init__.py,sha256=XLq0VmLoEBfnWjzYmxb_JRzAIqwZDv-2s10TO692TLc,59
+scripts/generate_visualizations.py,sha256=AJm2DNs-tiwdTHLivEQL9QkztmCclgGT1u4ds5QY4BQ,41812
+scripts/requirements.txt,sha256=EvUUoksfGtvbA45zkCG8to1EaPzWv1eurCONAp8Pdx4,112
+tests/__init__.py,sha256=yXNVJE20E2iHo0qbit5SgRE35eXWq89F1kkhNHy7VJA,31
+tests/test_compressor.py,sha256=-vMztSzY89n5dpShcACrFboEQOlfJ6FxF7eQOEU3swM,8273
+lopace-0.1.5.dist-info/METADATA,sha256=EdbjSZ4ACBxpJ7fLhWjHcAwl1Zf0brjsVtKCs5DtwaI,20780
+lopace-0.1.5.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+lopace-0.1.5.dist-info/top_level.txt,sha256=k-gL-51ulMq50vhNS91c1eyGRNse0vs_PzS9VdAiYlw,21
+lopace-0.1.5.dist-info/RECORD,,

{lopace-0.1.3.dist-info → lopace-0.1.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

scripts/README.md

@@ -0,0 +1,81 @@
+# Visualization Scripts
+
+This directory contains scripts for generating publication-quality visualizations of LoPace compression metrics.
+
+## generate_visualizations.py
+
+Generates comprehensive SVG visualizations suitable for research papers.
+
+### Features
+
+- Tests all compression methods (Zstd, Token, Hybrid) on 10 prompts
+- Prompts include small, medium, and very large sizes
+- Measures comprehensive metrics:
+  - Compression ratio
+  - Space savings
+  - Disk size (original vs compressed)
+  - Compression/decompression speed
+  - Memory usage
+  - Throughput
+
+### Generated Visualizations
+
+1. **compression_ratio.svg** - Compression ratio distribution and by prompt size
+2. **space_savings.svg** - Space savings percentages with error bars
+3. **disk_size_comparison.svg** - Original vs compressed disk sizes
+4. **speed_metrics.svg** - Compression/decompression time and throughput
+5. **memory_usage.svg** - Memory usage during compression/decompression
+6. **comprehensive_comparison.svg** - Heatmaps comparing all metrics
+7. **scalability_analysis.svg** - How metrics scale with prompt size
+
+### Usage
+
+```bash
+# Install dependencies
+pip install -r requirements-dev.txt
+
+# Run the script
+python scripts/generate_visualizations.py
+```
+
+### Output
+
+All visualizations are saved as high-resolution SVG files in the `screenshots/` directory:
+
+```
+screenshots/
+├── benchmark_data.csv          # Raw benchmark data
+├── compression_ratio.svg
+├── space_savings.svg
+├── disk_size_comparison.svg
+├── speed_metrics.svg
+├── memory_usage.svg
+├── comprehensive_comparison.svg
+└── scalability_analysis.svg
+```
+
+### Plot Specifications
+
+- **Format**: SVG (vector graphics, scalable)
+- **Resolution**: 300 DPI equivalent
+- **Fonts**: Serif fonts (Times New Roman) for publication quality
+- **Style**: Clean, professional design with legends and labels
+- **Size**: Optimized for paper inclusion (adjustable)
+
+### Customization
+
+Edit `scripts/generate_visualizations.py` to customize:
+- Number of test prompts
+- Prompt sizes and content
+- Plot colors and styles
+- Output directory
+- Additional metrics
+
+### Requirements
+
+- Python 3.8+
+- pandas
+- matplotlib
+- seaborn
+- numpy
+- lopace (installed)

scripts/requirements.txt

@@ -0,0 +1,5 @@
+# Additional dependencies for visualization script
+pandas>=2.0.0
+matplotlib>=3.7.0
+seaborn>=0.12.0
+numpy>=1.24.0

lopace-0.1.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-lopace/__init__.py,sha256=PYjZWZHhSITNgag9sF0qZ_yXgZaMa3R8_3FuasiH0Nc,351
-lopace/compressor.py,sha256=nUTWDcAPYvQaeSFKx_lne-D2xIQ02IMVGE4yLODo8qE,19060
-lopace-0.1.3.dist-info/licenses/LICENSE,sha256=uFUrlsfsOwx_8Nzhq2pUgNaJghcJxXBMML3l7T39Tm0,1067
-scripts/__init__.py,sha256=XLq0VmLoEBfnWjzYmxb_JRzAIqwZDv-2s10TO692TLc,59
-scripts/generate_visualizations.py,sha256=AJm2DNs-tiwdTHLivEQL9QkztmCclgGT1u4ds5QY4BQ,41812
-tests/__init__.py,sha256=yXNVJE20E2iHo0qbit5SgRE35eXWq89F1kkhNHy7VJA,31
-tests/test_compressor.py,sha256=-vMztSzY89n5dpShcACrFboEQOlfJ6FxF7eQOEU3swM,8273
-lopace-0.1.3.dist-info/METADATA,sha256=YhcHwNH6kR9exmyoITfc3LldbhaSxIdtDKeVZIVON88,18612
-lopace-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-lopace-0.1.3.dist-info/top_level.txt,sha256=k-gL-51ulMq50vhNS91c1eyGRNse0vs_PzS9VdAiYlw,21
-lopace-0.1.3.dist-info/RECORD,,