publicarray commited on
Commit
081e944
·
verified ·
1 Parent(s): 10be922

Model card: all four models, per-folder licences (Apache 2.0 and LFM 1.0), sources, tags and the TestFlight link

Browse files
Files changed (1) hide show
  1. README.md +76 -35
README.md CHANGED
@@ -1,51 +1,83 @@
1
  ---
2
- license: apache-2.0
3
- base_model: openbmb/MiniCPM5-1B
 
 
 
 
 
 
 
4
  pipeline_tag: text-generation
5
  library_name: coreai
6
  tags:
7
- - core-ai
8
- - ios
9
- - on-device
10
- - minicpm5
 
 
 
 
 
 
11
  ---
12
 
13
  # Fieldnote models
14
 
15
- MiniCPM5 1B compiled ahead of time for Apple's Core AI, one ready-to-load bundle per
16
- iPhone chip family. Used by [Fieldnote](https://github.com/array-ai/fieldnotes), an
17
- on-device meeting recorder, to write meeting notes without compiling the model on
18
- the phone (the on-phone compile of a larger model ran an iPhone 16 out of memory).
 
 
 
 
19
 
20
  ## Bundles
21
 
22
- | Folder | Core AI architecture | Phones |
23
- |---|---|---|
24
- | `ios-h17g` | h17g | iPhone 16 family |
25
- | `ios-h17p` | h17p | iPhone 16 family |
26
- | `ios-h18p` | h18p | iPhone 17 Pro |
 
 
 
 
 
 
27
 
28
  Each folder is a complete bundle: `metadata.json` (pointing at the compiled model),
29
- `tokenizer/`, and `minicpm5_1b_minicpm5_pal8_g32_static.<arch>.aimodelc`. A phone
30
- needs only the folder whose architecture matches `AIModel.deviceArchitectureName`.
31
- Other devices should use the portable model below and let Core AI compile it.
 
 
 
 
 
32
 
33
- ## Source and build
 
 
 
 
 
 
 
34
 
35
- - Model: [openbmb/MiniCPM5-1B](https://huggingface.co/openbmb/MiniCPM5-1B), 8-bit
36
- palettized, 4,096-token context.
37
- - Portable Core AI export: [mlboydaisuke/MiniCPM5-1B-CoreAI](https://huggingface.co/mlboydaisuke/MiniCPM5-1B-CoreAI)
38
- `ios-static/` at revision `f38d143ec50cb2e54d8388479b919e3b9283943b`.
39
- - Compiled on GitHub Actions (Xcode 27, Metal Toolchain) by
40
- [`compile-models.yml`](https://github.com/array-ai/fieldnotes/blob/main/.github/workflows/compile-models.yml):
41
 
42
  ```
43
- xcrun coreai-build compile minicpm5_1b_minicpm5_pal8_g32_static.aimodel \
44
- --platform iOS --min-deployment-version 27.0 --architecture <arch> --output <dir>
45
  ```
46
 
47
- Compute units were left to Core AI's default choice. Some on-device specialization
48
- still happens at first load, but not the full compile.
 
49
 
50
  ## Loading
51
 
@@ -53,16 +85,25 @@ still happens at first load, but not the full compile.
53
  import CoreAI
54
  import CoreAILanguageModels
55
 
56
- let arch = AIModel.deviceArchitectureName // e.g. "h17g"
57
- let bundle = modelsDirectory.appending(path: "ios-\(arch)")
58
  let model = try await CoreAILanguageModel(resourcesAt: bundle)
59
  ```
60
 
61
  Fieldnote downloads only the matching folder, from a pinned revision of this repo,
62
  and checks every file against its SHA-256 before use.
63
 
64
- ## Licence
 
 
 
 
 
 
 
 
 
 
65
 
66
- MiniCPM5 is released by OpenBMB under the Apache License 2.0, and so are these
67
- compiled bundles (see `LICENSE`). No weights were changed; the files here are the
68
- portable export compiled for specific chips.
 
1
  ---
2
+ license: other
3
+ license_name: apache-2.0-and-lfm1.0
4
+ license_link: https://huggingface.co/publicarray/fieldnote-models#licences
5
+ base_model:
6
+ - openbmb/MiniCPM5-1B
7
+ - openbmb/MiniCPM5-2B
8
+ - Qwen/Qwen3.5-2B
9
+ - LiquidAI/LFM2.5-1.2B-Instruct
10
+ base_model_relation: quantized
11
  pipeline_tag: text-generation
12
  library_name: coreai
13
  tags:
14
+ - core-ai
15
+ - coreai
16
+ - apple
17
+ - ios
18
+ - iphone
19
+ - on-device
20
+ - neural-engine
21
+ - minicpm5
22
+ - qwen3.5
23
+ - lfm2.5
24
  ---
25
 
26
  # Fieldnote models
27
 
28
+ Small language models compiled ahead of time for Apple's Core AI, one ready-to-load
29
+ bundle per iPhone chip family. Used by [Fieldnote](https://github.com/array-ai/fieldnotes),
30
+ an on-device meeting recorder, to write meeting notes on the phone. A phone with a
31
+ matching chip downloads a compiled bundle instead of compiling the model itself,
32
+ which ran an iPhone 16 out of memory for the larger models.
33
+
34
+ **Try Fieldnote:** [join the TestFlight beta](https://testflight.apple.com/join/c2M82CMX)
35
+ (iPhone 15 Pro or later, iOS 27).
36
 
37
  ## Bundles
38
 
39
+ | Folder | Model | Chip | Phones | Licence |
40
+ |---|---|---|---|---|
41
+ | `ios-h17g` | MiniCPM5 1B | h17g | iPhone 16 family | Apache 2.0 |
42
+ | `ios-h17p` | MiniCPM5 1B | h17p | iPhone 16 family | Apache 2.0 |
43
+ | `ios-h18p` | MiniCPM5 1B | h18p | iPhone 17 Pro | Apache 2.0 |
44
+ | `minicpm5-2b/ios-h17p` | MiniCPM5 2B | h17p | iPhone 16 family | Apache 2.0 |
45
+ | `minicpm5-2b/ios-h18p` | MiniCPM5 2B | h18p | iPhone 17 Pro | Apache 2.0 |
46
+ | `qwen3.5-2b/ios-h17p` | Qwen3.5 2B | h17p | iPhone 16 family | Apache 2.0 |
47
+ | `qwen3.5-2b/ios-h18p` | Qwen3.5 2B | h18p | iPhone 17 Pro | Apache 2.0 |
48
+ | `lfm2.5-1.2b/ios-h17p` | LFM2.5 1.2B Instruct | h17p | iPhone 16 family | LFM Open License 1.0 |
49
+ | `lfm2.5-1.2b/ios-h18p` | LFM2.5 1.2B Instruct | h18p | iPhone 17 Pro | LFM Open License 1.0 |
50
 
51
  Each folder is a complete bundle: `metadata.json` (pointing at the compiled model),
52
+ `tokenizer/`, and the compiled `.aimodelc`. A phone needs only the folder whose chip
53
+ matches `AIModel.deviceArchitectureName`. Other devices should use the portable
54
+ export (below) and let Core AI compile it.
55
+
56
+ ## Sources
57
+
58
+ Every bundle is a portable Core AI export compiled for one chip. No weights were
59
+ changed.
60
 
61
+ | Model | Original | Portable Core AI export, pinned revision |
62
+ |---|---|---|
63
+ | MiniCPM5 1B | [openbmb/MiniCPM5-1B](https://huggingface.co/openbmb/MiniCPM5-1B) | [mlboydaisuke/MiniCPM5-1B-CoreAI](https://huggingface.co/mlboydaisuke/MiniCPM5-1B-CoreAI) `ios-static/` @ `f38d143ec50cb2e54d8388479b919e3b9283943b` |
64
+ | MiniCPM5 2B | [openbmb/MiniCPM5-2B](https://huggingface.co/openbmb/MiniCPM5-2B) | [mlboydaisuke/MiniCPM5-2B-CoreAI](https://huggingface.co/mlboydaisuke/MiniCPM5-2B-CoreAI) `ios-static/` @ `39db5ff9480e5d80e423889e3bacb7f9e9b9e40f` |
65
+ | Qwen3.5 2B | [Qwen/Qwen3.5-2B](https://huggingface.co/Qwen/Qwen3.5-2B) | [mlboydaisuke/qwen3.5-2B-CoreAI](https://huggingface.co/mlboydaisuke/qwen3.5-2B-CoreAI) `gpu-pipelined-b2/qwen3_5_2b_decode_int8hu_block32_sym` @ `14e77014db5ae2f3de94825165f5ae58bededd7d` |
66
+ | LFM2.5 1.2B | [LiquidAI/LFM2.5-1.2B-Instruct](https://huggingface.co/LiquidAI/LFM2.5-1.2B-Instruct) | [mlboydaisuke/LFM2.5-1.2B-CoreAI](https://huggingface.co/mlboydaisuke/LFM2.5-1.2B-CoreAI) `gpu-pipelined-b2/lfm2_5_1_2b_instruct_decode_int8hu_block32_sym` @ `3e3241cbcf368a663768dcc4e5785c4f0a02bae4` |
67
+
68
+ ## Build
69
 
70
+ Compiled on GitHub Actions (Xcode 27, Metal Toolchain) by
71
+ [`compile-models.yml`](https://github.com/array-ai/fieldnotes/blob/main/.github/workflows/compile-models.yml):
 
 
 
 
72
 
73
  ```
74
+ xcrun coreai-build compile <model>.aimodel \
75
+ --platform iOS --min-deployment-version 27.0 --architecture <chip> --output <dir>
76
  ```
77
 
78
+ The MiniCPM5 1B bundles leave the compute unit to Core AI. The Qwen3.5, LFM2.5 and
79
+ MiniCPM5 2B h18p bundles are compiled for the Neural Engine. Some on-device
80
+ specialisation still happens at first load, but not the full compile.
81
 
82
  ## Loading
83
 
 
85
  import CoreAI
86
  import CoreAILanguageModels
87
 
88
+ let chip = AIModel.deviceArchitectureName // e.g. "h17p"
89
+ let bundle = modelsDirectory.appending(path: "qwen3.5-2b/ios-\(chip)")
90
  let model = try await CoreAILanguageModel(resourcesAt: bundle)
91
  ```
92
 
93
  Fieldnote downloads only the matching folder, from a pinned revision of this repo,
94
  and checks every file against its SHA-256 before use.
95
 
96
+ ## Licences
97
+
98
+ This repo holds models under two licences. Each model's folder carries its own
99
+ `LICENSE`:
100
+
101
+ - **MiniCPM5 1B and 2B** (OpenBMB) and **Qwen3.5 2B** (Qwen team, Alibaba Cloud):
102
+ [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). The 1B's licence
103
+ is the `LICENSE` at the repo root; the others are in `minicpm5-2b/` and `qwen3.5-2b/`.
104
+ - **LFM2.5 1.2B Instruct** (Liquid AI): LFM Open License v1.0, in `lfm2.5-1.2b/LICENSE`.
105
+ It allows commercial use only by organisations with under US$10 million in annual
106
+ revenue; read it before using these bundles.
107
 
108
+ Core AI exports by mlboydaisuke; ahead-of-time compiled builds by publicarray. The
109
+ files here are modified from the originals only by being compiled for a specific chip.