Metadata-Version: 2.4
Name: signate-wandb-sync
Version: 0.1.0
Summary: A CLI tool to record SIGNATE competition scores to W&B
Project-URL: Homepage, https://github.com/yasumorishima/signate-wandb-sync
Project-URL: Repository, https://github.com/yasumorishima/signate-wandb-sync
Author: yasunorim
License-Expression: MIT
License-File: LICENSE
Keywords: competition,machine-learning,mlops,signate,wandb,weights-and-biases
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Requires-Dist: click>=8.0
Requires-Dist: wandb>=0.16.0
Provides-Extra: dev
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Description-Content-Type: text/markdown

# signate-wandb-sync

A CLI tool to record SIGNATE competition scores to [Weights & Biases (W&B)](https://wandb.ai/).

## Installation

```bash
pip install signate-wandb-sync
```

## Usage

### score — Log SIGNATE scores to W&B

After submitting to SIGNATE and getting your score, record it to a W&B run:

```bash
# Full W&B URL
signate-wandb-sync score https://wandb.ai/your-entity/your-project/runs/abc123 --score 0.85 --rank 3

# With additional metrics
signate-wandb-sync score https://wandb.ai/your-entity/your-project/runs/abc123 \
    --score 0.85 --rank 3 \
    -m fbeta=0.85 -m recall=0.91

# Using bare run ID (requires --project)
signate-wandb-sync score abc123 --project your-entity/your-project --score 0.85
```

### Options

| Option | Description |
|---|---|
| `--score` | SIGNATE submission score (float) |
| `--rank` | Leaderboard rank (int) |
| `--metric KEY=VALUE` | Additional metric (repeatable) |
| `--project entity/project` | W&B project path (for bare run IDs) |

## Windows

```bash
PYTHONUTF8=1 signate-wandb-sync score <run_id> --score 0.85
```

## Authentication

W&B: run `wandb login` beforehand (or set `WANDB_API_KEY` environment variable).

## Requirements

- Python 3.9+
- [wandb](https://pypi.org/project/wandb/)

## License

MIT
