Skip to content
Back to search

mlview-local

MarketplaceWorks with Claude CodeGitHubIncomplete

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/realmyang--mlview/badge.svg)](/listings/realmyang--mlview)

HTML

<a href="/listings/realmyang--mlview"><img src="/api/listings/realmyang--mlview/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Each release attaches the extension (a `.vsix` file) and the two skill ZIPs to its page under Releases.

- Download the `.vsix` file. Install it with VS Code's **Extensions: Install from VSIX...** command. - Download the skill ZIP for your assistant and extract it at the root of your project. [The skill, per assistant](docs/user-guide.md#the-skill-per-assistant) says which ZIP is for which assistant. - For Claude Code, the skill is also packaged as a [plugin](claude-plugin/README.md).

To work from a clone of this repository instead, build the extension as [docs/development.md](docs/development.md#prerequisites) describes. You need Python 3.10 or newer with the packages of `requirements-dev.txt` in a virtual environment, and Node 20.18.1 or newer. Then copy the skill into your project with the installer:

python3 tools/install_skill.py /path/to/your/project

The installer copies the skill into the project's `.agents/skills/mlview/` folder. For Claude Code, add `--destination .claude/skills/mlview`.

Use one skill location in a project, not both. [The user guide](docs/user-guide.md) has the details.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 24 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "mlview-local",
  3. "owner": { "name": "MLView" },
  4. "metadata": {
  5. "description": "MLView's marketplace: the plugin from this checkout, and the same plugin fetched from GitHub.",
  6. "version": "0.4.0"
  7. },
  8. "plugins": [
  9. {
  10. "name": "mlview",
  11. "source": "./claude-plugin",
  12. "description": "A skill for Claude Code: read an ML project, write a workflow diagram that cites its source lines, and check and publish it with a local helper."
  13. },
  14. {
  15. "name": "mlview-github",
  16. "source": {
  17. "source": "git-subdir",
  18. "url": "https://github.com/realmyang/MLView.git",
  19. "path": "claude-plugin"
  20. },
  21. "description": "The same MLView plugin, installed from the repository on GitHub."
  22. }
  23. ]
  24. }
README.md · README · 143 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # MLView
  2. [![CI](https://github.com/realmyang/MLView/actions/workflows/ci.yml/badge.svg)](https://github.com/realmyang/MLView/actions/workflows/ci.yml)
  3. [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
  4. **Ask the assistant in your editor to explain an ML workflow, then explore its
  5. answer as an interactive diagram linked to the source.** MLView is a skill for
  6. GitHub Copilot, Codex and Claude Code, a document format, and a VS Code
  7. viewer. The assistant reads the code and configuration and writes the diagram:
  8. steps, connections and findings, with quotes from the files it read.
  9. **Preview.** The format and the viewer can still change between releases,
  10. and fixes go into the next release.
  11. ![A diagram in MLView with a step selected, its claim and quote in the side panel, and the cited lines open beside it](docs/images/overview.png)
  12. The diagram of `samples/configured_training`, with a step selected.
  13. ## How it works
  14. ```mermaid
  15. flowchart LR
  16. A[Your assistant + MLView skill] --> B[Read source and config]
  17. B --> C[LLM interpretation]
  18. C --> D[WorkflowDocument draft]
  19. D --> E[Local validation and publication]
  20. E --> F[Interactive VS Code diagram]
  21. F --> G[Source navigation]
  22. A -->|Explicit refinement| C
  23. ```
  24. - MLView needs no model API key of its own. Your assistant supplies the model,
  25. its tools and its permissions.
  26. - The skill's helper checks a draft's structure, cited paths and exact quotes,
  27. records file hashes, and publishes a `*.mlview.json` file.
  28. - Neither the helper nor the viewer imports or runs your code.
  29. - Opening, filtering and navigating a diagram never call a model.
  30. ## Install
  31. Each release attaches the extension (a `.vsix` file) and the two skill ZIPs
  32. to its page under Releases.
  33. - Download the `.vsix` file. Install it with VS Code's
  34. **Extensions: Install from VSIX...** command.
  35. - Download the skill ZIP for your assistant and extract it at the root of
  36. your project.
  37. [The skill, per assistant](docs/user-guide.md#the-skill-per-assistant)
  38. says which ZIP is for which assistant.
  39. - For Claude Code, the skill is also packaged as a
  40. [plugin](claude-plugin/README.md).
  41. To work from a clone of this repository instead, build the extension as
  42. [docs/development.md](docs/development.md#prerequisites) describes. You need
  43. Python 3.10 or newer with the packages of `requirements-dev.txt` in a
  44. virtual environment, and Node 20.18.1 or newer. Then copy the skill into
  45. your project with the installer:
  46. ```sh
  47. python3 tools/install_skill.py /path/to/your/project
  48. ```
  49. The installer copies the skill into the project's `.agents/skills/mlview/`
  50. folder. For Claude Code, add `--destination .claude/skills/mlview`.
  51. Use one skill location in a project, not both.
  52. [The user guide](docs/user-guide.md) has the details.
  53. ## A first diagram
  54. 1. Open your project in VS Code and start the `mlview` skill in your
  55. assistant. The [user guide](docs/user-guide.md#start-the-skill) says how.
  56. Ask, for example: "Explain training with train.py and configs/distill.json.
  57. Show where data enters, which model is updated, how the losses combine, how
  58. validation works, and what source inspection cannot establish. Tell me what
  59. looks wrong."
  60. 2. The assistant publishes a `*.mlview.json` file. Click it in the Explorer
  61. and it opens as the diagram. Select a step, connection or finding to read
  62. its claim and quotes. Press Enter to open the cited lines beside the
  63. diagram.
  64. 3. Ask the same assistant to refine the diagram. A valid new revision replaces
  65. the one on screen.
  66. ## Example
  67. [`samples/configured_training.mlview.json`](samples/configured_training.mlview.json)
  68. is a diagram of the small project in
  69. [`samples/configured_training/`](samples/configured_training/README.md). Open
  70. this repository in VS Code with the extension installed and click the file.
  71. The file records which assistant and model wrote it.
  72. ## What MLView checks, and what it does not
  73. - The helper and the extension check a document's structure, that every cited
  74. path is inside the workspace, the file hashes and the exact quotes.
  75. - A matching quote shows that the cited lines exist and have not changed. It
  76. does not show that they support the claim.
  77. - No automated check calls a model or opens VS Code.
  78. [What is checked, and what is not](docs/validation.md) says what the checks
  79. cover.
  80. - Treat a diagram as the assistant's reading of the code, and check it against
  81. the cited lines.
  82. ## In this repository
  83. | Path | What it holds |
  84. |---|---|
  85. | `skills/mlview/` | The skill: its instructions, reference files and helper, with the helper's tests |
  86. | `contracts/` | The JSON Schema of the format, and the cases the schema, the helper and the extension must agree on |
  87. | `vscode-extension/` | The VS Code extension |
  88. | `webview/` | The diagram viewer the extension shows |
  89. | `claude-plugin/` | The Claude Code plugin, with a generated copy of the skill |
  90. | `samples/` | Small example projects and example diagrams |
  91. | `tools/`, `scripts/` | Install, package, build and check tools, with their tests |
  92. | `docs/` | The user guide, the format reference, and pages on the architecture, development, releasing and what is checked |
  93. ## Develop
  94. Use a Python 3.10+ virtual environment and Node 20.18.1 or newer.
  95. ```sh
  96. python -m pip install -r requirements-dev.txt
  97. sh scripts/e2e.sh
  98. ```
  99. On Windows run `pwsh -File scripts/e2e.ps1`. The full check builds the
  100. viewer and the extension, type-checks and tests them, runs the Python tests
  101. and the documentation link check, and packages the two skill ZIPs and the
  102. VSIX. [CONTRIBUTING.md](CONTRIBUTING.md) has the steps for a change, and
  103. [docs/development.md](docs/development.md) has the commands for each part.
  104. ## More
  105. - The [user guide](docs/user-guide.md)
  106. - [The format and the helper's commands](docs/format.md), and the format's
  107. [JSON Schema](contracts/workflow.schema.json)
  108. - The [architecture](docs/architecture.md), [development](docs/development.md)
  109. and [what is checked, and what is not](docs/validation.md)
  110. - The skill: [skills/mlview/SKILL.md](skills/mlview/SKILL.md)
  111. - [Contributing](CONTRIBUTING.md), the [security policy](SECURITY.md) and the
  112. [code of conduct](CODE_OF_CONDUCT.md)
  113. - The [changelog](CHANGELOG.md), the [license](LICENSE) and the
  114. [third-party notices](THIRD_PARTY_NOTICES.md)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.