Skip to main content

Generating model cards for models in Jupyter Notebook.

Project description

jlmc

Generate documentation cards for code in JupyterLab.

Requirements

  • JupyterLab >= 3.0

Installation

pip install jlmodelcards

Development Installation

There are two versions of this extension, each supporting v2 and v3 of JupyterLab.

Create a conda environment if you do not have an environment already.

conda create -n [environment-name] --override-channels --strict-channel-priority -c conda-forge -c anaconda jupyterlab cookiecutter nodejs git

Activate the environment.

conda activate [environment-name]

Since there is only one python dependeny, there is no environment.yml file. You can install the jupyterlab package.

# for JupyterLab 3.x 
conda install -c conda-forge jupyterlab

If you want to install the previou version of Jupyterlab.

# for JupyterLab 2.x 
conda install -c conda-forge jupyterlab=2

Once you install jupyterlab, you can access jlpm which is JupyterLab's pinned version of yarn.

# Install dependencies
jlpm install

You can install the extension without building as well.

jupyter labextension install . --no-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.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Once you make any changes to the code, you can rebuild the extension.

jlpm run build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jlmodelcards-0.0.14.tar.gz (1.0 MB view hashes)

Uploaded source

Built Distribution

jlmodelcards-0.0.14-py3-none-any.whl (2.0 MB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page