Sync 509: 25 new resources; annotation cleanup; card body, date_added, load_dataset snippet
Browse files- meta/hf_card_body.md +48 -0
meta/hf_card_body.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
## Dataset Structure
|
| 3 |
+
|
| 4 |
+
Each row in `data/resources.jsonl` (and the equivalent `data/resources.csv`) is one curated resource, exported from the English `README.md`.
|
| 5 |
+
|
| 6 |
+
| Field | Description |
|
| 7 |
+
| --- | --- |
|
| 8 |
+
| `row_id` | Positional identifier (`ale-NNNN`); not stable across README reorders. |
|
| 9 |
+
| `section` | The `##` section the entry lives under. |
|
| 10 |
+
| `section_slug` | Anchor-style slug of the section. |
|
| 11 |
+
| `resource_type` | Paper, Blog, Docs, Tool, Benchmark, Pattern, Template, List, or Critique. |
|
| 12 |
+
| `marker` | Emoji shown before the entry in the README. |
|
| 13 |
+
| `title` | Linked entry title. |
|
| 14 |
+
| `url` | Resource URL. |
|
| 15 |
+
| `url_kind` | `external` or `local_path` (a file inside the repository). |
|
| 16 |
+
| `domain` | Host of an external URL (empty for local paths). |
|
| 17 |
+
| `annotation` | The one-line description as written in the README. |
|
| 18 |
+
| `description` | Copy of the annotation for tooling that expects a `description` field. |
|
| 19 |
+
| `key_contribution` | Short statement of what the resource adds. |
|
| 20 |
+
| `novelty` | Why the entry is distinct within its section. |
|
| 21 |
+
| `impact` | Who benefits and how. |
|
| 22 |
+
| `signal` | Why the entry is trustworthy (adoption, venue, authorship). |
|
| 23 |
+
| `signal_strength` | Coarse confidence label (`strong`, `medium`, `contextual`). |
|
| 24 |
+
| `source_readme` | README file the row came from. |
|
| 25 |
+
| `source_line` | 1-based line number in that README. |
|
| 26 |
+
| `source_url` | Permalink to the source line on GitHub. |
|
| 27 |
+
|
| 28 |
+
## Considerations and Limitations
|
| 29 |
+
|
| 30 |
+
- Annotations are written and curated by a single maintainer; they summarize each resource and are not the authors' own abstracts.
|
| 31 |
+
- URLs are third-party and can rot; `data/resource_source_audit.csv` carries a retrieval-time reachability snapshot, but it is a point-in-time check, not a live guarantee.
|
| 32 |
+
- `row_id` and `source_line` are positional and change when the README is reordered; join on `url` for anything durable.
|
| 33 |
+
- Coverage skews toward English-language, publicly available resources.
|
| 34 |
+
|
| 35 |
+
## Changelog
|
| 36 |
+
|
| 37 |
+
Versioned changes are published as GitHub Releases: https://github.com/ChaoYue0307/awesome-loop-engineering/releases
|
| 38 |
+
|
| 39 |
+
## Citation
|
| 40 |
+
|
| 41 |
+
```bibtex
|
| 42 |
+
@misc{chaoyue2026awesome_loop_engineering,
|
| 43 |
+
author = {He, Chaoyue},
|
| 44 |
+
title = {Awesome Loop Engineering},
|
| 45 |
+
year = {2026},
|
| 46 |
+
howpublished = {\url{https://github.com/ChaoYue0307/awesome-loop-engineering}}
|
| 47 |
+
}
|
| 48 |
+
```
|