llama.serve.jupyter package

Launch a Jupyter Notebook server.

llama.serve.jupyter.load_readme(readonly=True, clobber=True)

Copy the LLAMA JUPYTER README Jupyter notebook to the output directory (fetching it first from LLAMA S3 if necessary), set it as trusted, and set its permissions to readonly. Deletes the old README if present.

Parameters
  • readonly (bool, optional) – If True, set the README to readonly mode so that user’s can’t accidentally break it. Set this to False to allow editing when making changes to the README notebook (and remember to commit those changes with llama dev upload).

  • clobber (bool, optional) – If True, overwrite any existing README files. In production, you usually want this to be True since it will ensure you get the latest version of the documentation. While developing, you probably want this to be False so that you can keep incrementally modifying your README until you’re ready to commit the changes to LLAMA S3.

Returns

README_LOCAL – the path to the local README Jupyter notebook.

Return type

pathlib.Path

Submodules