!!! note “Not on PyPI” This project isn’t published on PyPI yet. Install it from the GitHub repo using uv or pip.
!!! tip “Install uv (Linux/macOS)”
bash title="Install uv"
curl -LsSf https://astral.sh/uv/install.sh | sh
=== “uvx (no clone)”
```bash title="Run instantly"
uvx --from "git+https://github.com/Ash-Blanc/paper2sw.git@main#subdirectory=paper2sw" \
paper2sw predict \
--paper https://arxiv.org/abs/2411.07191 \
--out sw.jsonl \
--top_k 5
```
=== “uv (editable dev setup)”
```bash title="Clone & set up"
git clone https://github.com/Ash-Blanc/paper2sw
cd paper2sw
uv sync # creates a virtual env and installs the workspace (editable)
```
```bash title="CLI examples"
uv run paper2sw predict \
--paper ./README.md \
--out sw.jsonl \
--top_k 3 \
--keep_ratio 0.5
# Batch mode
uv run paper2sw batch \
--papers ./README.md ./LICENSE \
--out_dir ./outs \
--top_k 2
```
=== “pip (no uv)”
```bash title="Install from GitHub"
python -m venv .venv
source .venv/bin/activate # Windows: .venv\\Scripts\\activate
pip install "git+https://github.com/Ash-Blanc/paper2sw.git@main#subdirectory=paper2sw"
```
```bash title="Use the CLI"
paper2sw predict \
--paper https://arxiv.org/abs/2411.07191 \
--out sw.jsonl \
--top_k 5
```
```python title=”Predict via Python” from paper2sw import Predictor
predictor = Predictor.from_pretrained(enable_cache=True, selection_keep_ratio=0.5) preds = predictor.predict(“./README.md”, top_k=5) for p in preds: print(p) ```
!!! tip
- --keep_ratio keeps only a fraction of the most relevant text before inference (1.0 = keep all).
- To disable caching for a run, pass --no_cache in the CLI.