# jupyterlab-model-card

> Generate model cards for machine learning models

Latest version **1.0.0** (published 2021-02-26) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install jupyterlab-model-card
pnpm add jupyterlab-model-card
yarn add jupyterlab-model-card
bun add jupyterlab-model-card
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-02-26 |
| First published | 2021-02-26 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 178.2 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Sixian |
| Maintainers | gracexwho |
| Keywords | jupyter, jupyterlab, jupyterlab-extension |

## Links

- npm: https://www.npmjs.com/package/jupyterlab-model-card
- Repository: https://github.com/Deerhound579/jupyterlab-ext-tut
- Homepage: https://github.com/Deerhound579/jupyterlab-model-card
- Issues: https://github.com/Deerhound579/jupyterlab-model-card/issues
- npm.io page: https://npm.io/package/jupyterlab-model-card

## Dependencies (10)

- [antd](https://npm.io/package/antd.md) ^4.6.5
- [immer](https://npm.io/package/immer.md) ^7.0.14
- [use-immer](https://npm.io/package/use-immer.md) ^0.4.1
- [react-markdown](https://npm.io/package/react-markdown.md) ^5.0.3
- [styled-components](https://npm.io/package/styled-components.md) ^5.2.1
- [@jupyterlab/launcher](https://npm.io/package/@jupyterlab/launcher.md) ^2.2.5
- [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) ^2.2.6
- [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^2.0.0
- [@types/styled-components](https://npm.io/package/@types/styled-components.md) ^5.1.4
- [modified-python-program-analysis](https://npm.io/package/modified-python-program-analysis.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2021-02-26

## README

# jupyterlab-model-card

## Requirements

- JupyterLab >= 2.0

## Install

```bash
jupyter labextension install jupyterlab-model-card
```

## Development

### [Resources for extension development](https://www.notion.so/3e617d2f2d56464a8c8f7f19890c36e7?v=61474bad874443b39e8925d47401b790)

### Install

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` instead of `jlpm` below.

```bash
# Clone the repo to your local environment
# Move to jupyterlab-model-card directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

### Uninstall

```bash
jupyter labextension uninstall jupyterlab-model-card
```

---
_Source: https://npm.io/package/jupyterlab-model-card · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
