Skip to content

Commit 714a097

Browse files
add information on Template creation for this project
Signed-off-by: Tomás González <tomasagustin.gonzalezorlando@arm.com>
1 parent 4899130 commit 714a097

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

content/learning-paths/cross-platform/deploy-ml-model-to-npu-with-topo/build-the-template.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,47 @@ The project has three implementation areas:
1818

1919
When bootstrapping this Template from scratch, first make the project work as a normal Compose build. Then add the `x-topo` metadata that lets Topo deploy it consistently to an Arm64 target.
2020

21+
## Install the Topo Template authoring skills
22+
23+
The [Topo Template Format](https://github.com/arm/Topo-Template-Format) repository includes public authoring skills for agents that support skill installation:
24+
25+
- `topo-template-context`: provides Topo and Topo Template reference context for `x-topo` metadata, schema, docs, and CLI Template behavior.
26+
- `topo-template-bootstrap`: converts a Compose repository into a Topo Template by adding or improving `compose.yaml` and `x-topo` metadata.
27+
- `topo-template-lint`: reviews a Topo Template for schema correctness, metadata consistency, deployment success messages, and build argument wiring.
28+
29+
Install the skills with `npx skills`:
30+
31+
```bash
32+
npx skills add arm/topo-template-format
33+
```
34+
35+
If your agent does not use `npx skills`, clone the Template Format repository and manually copy or symlink the directories under `skills/` into your agent's skills directory:
36+
37+
```bash
38+
git clone https://github.com/arm/Topo-Template-Format.git
39+
```
40+
41+
Restart your agent after installing or updating the skills.
42+
43+
You can then use the skills as part of the Template authoring flow. From the root of any Compose project, ask your agent to use `topo-template-bootstrap`:
44+
45+
```output
46+
Use topo-template-bootstrap on this repository.
47+
Treat the root compose.yaml as the Template root.
48+
Preserve plain docker compose behavior.
49+
Add x-topo metadata only where it reflects the actual services, hardware requirements, and build arguments.
50+
```
51+
52+
After bootstrap, ask the agent to use `topo-template-lint`:
53+
54+
```output
55+
Use topo-template-lint on topo-imx93-npu-deployment.
56+
Validate compose.yaml against the Topo Template Format schema.
57+
Check README alignment, deployment_success_message, Remoteproc Runtime metadata, and x-topo.args wiring.
58+
```
59+
60+
The lint pass should confirm that the Template has a root-level `x-topo.name`, that non-remoteproc services use `platform: linux/arm64`, that `cm33-runner` uses the Remoteproc Runtime annotation, and that every `x-topo.args` entry is carried into Compose or Docker build arguments where appropriate.
61+
2162
## Create the runner build pipeline
2263

2364
The `executorch-runner/Dockerfile` is a multi-stage Dockerfile. It builds two artifacts from one build context:

0 commit comments

Comments
 (0)