Skip to content

Commit 2d2fda2

Browse files
authored
docs: Documentation updates (#62)
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
1 parent f51bfe0 commit 2d2fda2

7 files changed

Lines changed: 23 additions & 33 deletions

File tree

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ The generated site will be written to `.mkdocs/site/`.
4141

4242
The top-level `README.md` remains the main user guide for installation and CLI
4343
usage. This docs tree explains the core architecture, CLI, output shape, and
44-
backend-management model.
44+
backend management model.
4545

4646
## Relationship to plugins
4747

48-
Plugin packages own the target-specific, backend-specific, and converter-specific
49-
detail. Keep that material in the plugin repos rather than copying it into the
50-
core repo.
48+
Plugin packages own the target-specific, backend-specific, and transformer or
49+
converter-specific detail. Keep that material in the plugin repos rather than
50+
copying it into the core repo.

docs/source/backends.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
77

88
## Overview
99

10-
The core `mlia` repository provides backend discovery and backend-management
10+
The core `mlia` repository provides backend discovery and backend management
1111
commands, while many backend implementations now live in split plugin
1212
repositories.
1313

docs/source/cli.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,6 @@ mlia backend list
3737
That gives you a quick picture of what the environment can actually do before
3838
you start copying example commands from documentation.
3939

40-
## Legacy entry points
41-
42-
The `mlia-target` and `mlia-backend` scripts remain available as compatibility
43-
wrappers. They print deprecation warnings and dispatch to the corresponding
44-
command group. Prefer `mlia target ...` and `mlia backend ...` in new commands,
45-
documentation, scripts, and examples.
46-
4740
## Common workflows
4841

4942
Show top-level help:
@@ -118,7 +111,7 @@ assuming a plugin-specific example applies to your setup.
118111
## Plugin relationship
119112

120113
The core repo provides the commands and workflow orchestration. Plugin packages
121-
provide target plugins, backend plugins, and converter plugins that are
114+
provide target plugins, backend plugins, and transformer plugins that are
122115
installed into that experience.
123116

124117
A useful mental model is:

docs/source/execution_flow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ graph LR
7878
model --> collectors[Data collectors]
7979
profile --> advisor[Target advisor]
8080
advisor --> collectors
81-
collectors --> maybeConvert{Converter needed?}
82-
maybeConvert -->|yes| converter[Converter plugin]
83-
converter --> intermediate[Converted/intermediate artifact]
84-
maybeConvert -->|no| backendInput[Backend input artifact]
81+
collectors --> maybeTransform{Transformation needed?}
82+
maybeTransform -->|yes| transformer[Transformer plugin]
83+
transformer --> intermediate[Converted/intermediate artifact]
84+
maybeTransform -->|no| backendInput[Backend input artifact]
8585
intermediate --> backendInput
8686
backendInput --> backend[Backend tool or service]
8787
backend --> rawResults[Raw backend output]

docs/source/high_level_architecture.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ graph TD
2525
mainCli --> backendCli[mlia backend]
2626
mainCli --> targetCli[mlia target]
2727
mainCli --> cliPlugins[CLI plugin commands]
28-
legacyBackend[mlia-backend compatibility wrapper] --> backendCli
29-
legacyTarget[mlia-target compatibility wrapper] --> targetCli
3028
checkCommand --> api
3129
3230
backendCli --> backendCommands[backend install/list/uninstall]
@@ -63,7 +61,7 @@ graph TD
6361

6462
| Layer | Core modules | Responsibility |
6563
| --- | --- | --- |
66-
| CLI | `mlia.cli.main`, `mlia.cli.commands`, `mlia.cli.command_validators` | Parse the root `mlia` command, including `check`, `backend`, and `target` command groups; keep legacy `mlia-backend` and `mlia-target` wrappers available with deprecation warnings; create `ExecutionContext` only for commands that need analysis context; configure logging and output format; and call command functions. |
64+
| CLI | `mlia.cli.main`, `mlia.cli.commands`, `mlia.cli.command_validators` | Parse the root `mlia` command, including `check`, `backend`, and `target` command groups; create `ExecutionContext` only for commands that need analysis context; configure logging and output format; and call command functions. |
6765
| Public API | `mlia.api` | Validate inputs, resolve targets and backends, ensure required backends are installed, create advisors, optionally return standardized output. |
6866
| Registries | `mlia.target.registry`, `mlia.backend.registry`, `mlia.plugins.*` | Load plugin entry points once and expose registered target, backend, converter, and CLI capabilities. |
6967
| Backend management | `mlia.backend.manager`, `mlia.backend.install`, `mlia.backend.config` | Show backend status, install/uninstall backends, resolve dependencies, and provide backend configuration metadata. |
@@ -76,10 +74,10 @@ graph TD
7674
The core package should not need target-specific conditionals for every new
7775
hardware family or converter. Instead:
7876

79-
- target plugins register target metadata and advisor factories
80-
- backend plugins register backend configuration and installation metadata
81-
- converter plugins register named converter callables
82-
- CLI plugins can append commands to the command list
77+
- Target plugins register target metadata and advisor factories.
78+
- Backend plugins register backend configuration and installation metadata.
79+
- Transformer plugins register named model transformation callables.
80+
- CLI plugins can append commands to the command list.
8381

8482
This keeps core orchestration stable while allowing target, backend, and
85-
converter packages to evolve independently.
83+
transformer packages to evolve independently.

docs/source/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ together, how JSON output is structured, or how plugins are discovered, this is
1515
the right package.
1616

1717
If you are trying to understand the detailed behaviour of a specific target,
18-
backend family, or converter path, the owning plugin package is the right place
19-
to go next.
18+
backend family, or model transformation path, the owning plugin package is the
19+
right place to go next.
2020

2121
## What this documentation covers
2222

2323
This documentation focuses on the shared MLIA experience: how to run the core
2424
workflows, how results are structured, and how plugins are discovered and used.
2525

26-
For in-depth target-specific, backend-specific, or converter-specific detail,
26+
For in-depth target-specific, backend-specific, or transformer-specific detail,
2727
see the individual plugin packages.

docs/source/plugin_architecture.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ conversion stacks.
1717
The core `mlia` package provides:
1818

1919
- The `mlia` CLI, including the `target` and `backend` command groups.
20-
- Legacy `mlia-target` and `mlia-backend` compatibility wrappers.
2120
- Plugin discovery and registration.
2221
- Shared workflow abstractions.
2322
- Common reporting and output schema logic.
@@ -29,11 +28,11 @@ Plugin packages provide one or more of:
2928

3029
- Target plugins.
3130
- Backend plugins.
32-
- Converter plugins.
31+
- Transformer plugins.
3332
- Bundled target profiles and backend resources.
3433

35-
Examples include target-focused plugins, backend-focused plugins, and converter
36-
plugins that extend the larger MLIA workflow.
34+
Examples include target-focused plugins, backend-focused plugins, and
35+
transformer plugins that extend the larger MLIA workflow.
3736

3837
See the individual plugin packages for in-depth target-specific,
39-
backend-specific, and converter-specific documentation.
38+
backend-specific, and transformer-specific documentation.

0 commit comments

Comments
 (0)