aceOfDiamonds commited on
Commit
37e2eab
·
1 Parent(s): a5764d2

Add the unshipped-backends generated section

Browse files

A backend directory holding a NOTES.md and no .pte was exported and not
published. 31 such notes existed across the estate with nothing in the cards
pointing at them.

Files changed (1) hide show
  1. MODEL_CARD.md +18 -3
MODEL_CARD.md CHANGED
@@ -1,7 +1,7 @@
1
  # Model card standard
2
 
3
  Every `software-mansion/react-native-executorch-*` repository carries a
4
- `README.md` in this shape. Four sections are **generated** from the repository
5
  tree and its `config.json` files, so they cannot drift from what is published.
6
  Anything a model needs beyond them is a **free section**, written by hand and
7
  kept as-is.
@@ -77,7 +77,22 @@ which tokens are quantized, so the card does not repeat that partition. Nor
77
  does it name a default, because the library resolves one per platform and a
78
  second answer here would only compete with it.
79
 
80
- ### 3. Repository structure
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
81
 
82
  Every tracked file except `README.md` and dotfiles, with its size, so a reader
83
  can see the download cost before fetching.
@@ -95,7 +110,7 @@ xnnpack/model_xnnpack_fp32.pte 31.1 MB
95
 
96
  Sizes render as `B`, `kB`, `MB` or `GB`.
97
 
98
- ### 4. Compatibility
99
 
100
  Fixed text, parameterised only by the ExecuTorch runtime version. It states
101
  the runtime the files are **published for**, and deliberately does not claim
 
1
  # Model card standard
2
 
3
  Every `software-mansion/react-native-executorch-*` repository carries a
4
+ `README.md` in this shape. Five sections are **generated** from the repository
5
  tree and its `config.json` files, so they cannot drift from what is published.
6
  Anything a model needs beyond them is a **free section**, written by hand and
7
  kept as-is.
 
77
  does it name a default, because the library resolves one per platform and a
78
  second answer here would only compete with it.
79
 
80
+ ### 3. Unshipped backends
81
+
82
+ Omitted unless the repository has one. A backend directory carrying a
83
+ `NOTES.md` and no `.pte` was exported and not published; the note records what
84
+ went wrong, and the card links it rather than repeating it.
85
+
86
+ ```markdown
87
+ ## Unshipped backends
88
+
89
+ A backend directory carrying a `NOTES.md` and no `.pte` was exported and
90
+ not published. Its note records what went wrong.
91
+
92
+ - `coreml` ([why](https://huggingface.co/software-mansion/<repo>/blob/main/coreml/NOTES.md))
93
+ ```
94
+
95
+ ### 4. Repository structure
96
 
97
  Every tracked file except `README.md` and dotfiles, with its size, so a reader
98
  can see the download cost before fetching.
 
110
 
111
  Sizes render as `B`, `kB`, `MB` or `GB`.
112
 
113
+ ### 5. Compatibility
114
 
115
  Fixed text, parameterised only by the ExecuTorch runtime version. It states
116
  the runtime the files are **published for**, and deliberately does not claim