CONTRIBUTING.md

# Contributing a model to Cropilot Community

## 1. Choose a name

Use a short, lowercase, descriptive name following this pattern:

```
<collection>_<task>_v<version>
```

- `collection` — document type or dataset, e.g. `newspaper`, `book`, `general`
- `task` — what it does, e.g. `outer_crop`, `inner_crop`, `rotate`
- `version` — bump on every retrain, e.g. `v1`, `v2`

Examples: `newspaper_outer_crop_v1`, `book_rotate_v2`, `general_inner_crop_v1`.

The weight file inside the repo should match the repo name, e.g. `newspaper_outer_crop_v1.pt`.

## 2. Create the model repository

Web: go to https://huggingface.co/new → under **Owner** select **cropilot-community** → enter the name from step 1 → Create.

CLI:

```bash
huggingface-cli repo create <model-name> --type model --organization cropilot-community
```

## 3. Add the model card

1. Copy the entire contents of [MODEL_CARD_TEMPLATE.md](./MODEL_CARD_TEMPLATE.md) into a file named `README.md`.
2. Replace every `{{ ... }}` placeholder. Do **not** change the YAML block at the top except where a placeholder asks you to — the tags, license, library, and task are already set correctly for the Cropilot ecosystem.

That's it for metadata — you don't need to add tags or pick a license manually; the template does it.

## 4. Upload your files

You need two files: your weights and the `README.md` model card.

Web: open the model page → **Files and versions** → **Add file** → drag in your `.pt`/`.pth` and the `README.md`.

CLI:

```bash
huggingface-cli upload cropilot-community/<model-name> ./<model-name>.pt
huggingface-cli upload cropilot-community/<model-name> ./README.md
```

## 5. Add it to a Collection (optional but encouraged)

On the org page, group your model into a Collection (e.g. *Crop models*, *Rotation models*) so it's easy to find. Open your model → **+ Collection** → pick or create one under cropilot-community.


Thanks for contributing! 🌾