Skip to content

Template for LLM Development, Incorporating Relevant Documentation

Developing Requirements

Python version python3.10 or later.

Build venv for MacOS, Linux

1
2
3
4
5
$ python3.10 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ deactivate
$ rm -rf venv     # remove the venv

Build venv for Windows

1
2
3
4
5
6
$ pip install virtualenv
$ virtualenv venv
$ venv\Scripts\activate
$ pip install -r requirements.txt
$ deactivate
$ rmdir /s venv     # remove the venv

Build docs

Requirements

1
2
3
4
5
6
7
pip install mkdocs
pip install mkdocs-material
pip install pymdown-extensions
pip install mkdocstrings
pip install mkdocs-git-revision-date-plugin
pip install mkdocs-jupyter
pip install ipykernel

In localhost

1
$ mkdocs server

If you want to build the docs successfully, there are some requirements: 1. Make sure the repository is public. 2. Go to setting -> Pages -> Branch -> gh-pages -> Save.