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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jlmodelcards-0.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be5a7e14b59e40805cc491ae08453aca527007662576a2a646b3b4a226d7d0a5 |
|
MD5 | 160be6fb8ed0c504662c4b73e87de752 |
|
BLAKE2b-256 | 482e16013c55ce4e8be0fc8ebdbba02552d06151a1bf821bdc5f6b07719bb3ba |