waterfall 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

{waterfall-0.1.2.dist-info → waterfall-0.1.3.dist-info}/METADATA

@@ -1,23 +1,22 @@
 Metadata-Version: 2.4
 Name: waterfall
-Version: 0.1.2
+Version: 0.1.3
 Summary: Scalable Framework for Robust Text Watermarking and Provenance for LLMs
-Author-email: Xinyuan Niu <aperture@outlook.sg>
-License-Expression: Apache-2.0
 Project-URL: Homepage, https://github.com/aoi3142/Waterfall
 Project-URL: Issues, https://github.com/aoi3142/Waterfall/issues
-Classifier: Programming Language :: Python :: 3
+Author-email: Xinyuan Niu <aperture@outlook.sg>
+License-Expression: Apache-2.0
+License-File: LICENSE
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: accelerate>=0.29.0
 Requires-Dist: numpy>=2.0.0
 Requires-Dist: scipy>=1.13.0
 Requires-Dist: sentence-transformers>=3.0.0
 Requires-Dist: torch>=2.3.0
 Requires-Dist: transformers>=4.43.1
-Dynamic: license-file
+Description-Content-Type: text/markdown
 
 # Waterfall: Scalable Framework for Robust Text Watermarking and Provenance for LLMs [EMNLP 2024 Main Long]
 Gregory Kang Ruey Lau*, Xinyuan Niu*, Hieu Dao, Jiangwei Chen, Chuan-Sheng Foo, Bryan Kian Hsiang Low
@@ -53,7 +52,7 @@ Protecting intellectual property (IP) of text such as articles and code is incre
 
 5. A token is sampled from the perturbed logits $\check{L}$ and is appended to the watermarked text.
 
-6. Append the generated token to the prompt and continue autoregressive generation (steps 1-5) until the eos token.
+6. Append the generated token to the prompt and continue autoregressive generation (steps 1-5) until the `eos` token.
 
 # Verification of un/watermarked text
 
@@ -77,12 +76,12 @@ Protecting intellectual property (IP) of text such as articles and code is incre
 
 # Using our code
 
-Install our package from pypi
+Install our package using `pip`
 ```sh
 pip install waterfall
 ```
 
-## Alterntive installation from source
+## Alternative installation from source
 
 [Optional]
 If using `conda` (or other pkg managers), it is highly advisable to create a new environment
@@ -92,7 +91,7 @@ conda create -n waterfall python=3.11 --yes   `# Compatible with python version
 conda activate waterfall
 ```
 
-Clone and install our package from source
+Clone and install our package
 ```sh
 git clone https://github.com/aoi3142/Waterfall.git
 pip install -e Waterfall        `# Install in 'editable' mode with '-e', can be omitted`
@@ -105,7 +104,7 @@ Use the command `waterfall_demo` to watermark a piece of text, and then verify t
 waterfall_demo
 ```
 
-\* Ensure that your device (cuda/cpu/mps) has enough memory to load the model (~16GB for default Llama 3.1 8B model)
+\* Ensure that your device (`cuda`/`cpu`/`mps`) has enough memory to load the model and perform inference (~18GB+ for default Llama 3.1 8B model)
 
 Additional arguments
 ```sh

{waterfall-0.1.2.dist-info → waterfall-0.1.3.dist-info}/RECORD

@@ -5,9 +5,8 @@ waterfall/WatermarkingFnSquare.py,sha256=2PAO05DdKT02npo7GDf_82D520nP7kGAWK6H4E4
 waterfall/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 waterfall/permute.py,sha256=RwxOHFhx_VSOhhFwy5s79YgwTUBkfW2-LCCXYR3VT2o,2582
 waterfall/watermark.py,sha256=whiNhPwWNNIZwXMH6r7QzEE3A7Niq2Ro9elA1iSRoxI,11952
-waterfall-0.1.2.dist-info/licenses/LICENSE,sha256=zAtaO-k41Q-Q4Etl4bzuh7pgNJsPH-dYfzvznRa0OvM,11341
-waterfall-0.1.2.dist-info/METADATA,sha256=zDciBMgLwmhhf8voqFzLeCOruNQBdqtohMUYKDMzmdQ,8715
-waterfall-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-waterfall-0.1.2.dist-info/entry_points.txt,sha256=XXnUzuWXu2nc9j4WAll9tq6HyodN_8WJLjeG0O4Y2Gw,60
-waterfall-0.1.2.dist-info/top_level.txt,sha256=5rTgijeT9V5GRCwIDZmhjeZ4khgH1lmfhS9ZmdUUCKQ,10
-waterfall-0.1.2.dist-info/RECORD,,
+waterfall-0.1.3.dist-info/METADATA,sha256=hnX9Vq2zjuq_u9VxJcP9OQ5U2RHUtTGnTQu6iwUJhXM,8715
+waterfall-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+waterfall-0.1.3.dist-info/entry_points.txt,sha256=XXnUzuWXu2nc9j4WAll9tq6HyodN_8WJLjeG0O4Y2Gw,60
+waterfall-0.1.3.dist-info/licenses/LICENSE,sha256=zAtaO-k41Q-Q4Etl4bzuh7pgNJsPH-dYfzvznRa0OvM,11341
+waterfall-0.1.3.dist-info/RECORD,,

{waterfall-0.1.2.dist-info → waterfall-0.1.3.dist-info}/WHEEL

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

waterfall-0.1.2.dist-info/top_level.txt

@@ -1 +0,0 @@
-waterfall