Just Artificial Inteliigence Snippets (JAIS)
Project description
Just Artificial Intelligence Stuff (JAIS)
[TODO NEXT]
- add base tests
Before these:
- init docs
- update README Do this:
- Add confusion matrix visualization at the end of training and validation. Maybe save somewhere?
- add model saving script
- add learning rate warmup
- add learning rate finder
- automatic batch size finder
- IMPLEMENT SWA MODEL AND LR_SCHEDULER, see https://pytorch.org/docs/stable/optim.html (GOTO section: Stochastic Weight Averaging)
-
FIND THE HYPERPARAMETERS AUTOMATICALLY AND SAVE THEM IN FILE FOR LATER USE
How to Install (added on 3 Nov 2021, rewrite the README)
Prerequisites to install Python 3.8 virtual env
apt update
apt install software-properties-common
add-apt-repository ppa:deadsnakes/ppa
apt update
apt install python3.8 python3.8-venv python3.8-dev
Create a virtual env
make make_venv
Start here (copy-paste these commands):
-
create a virtual env and install base packages
Running
make
command will create, install requirements fromrequirements_base.txt
file, and install this project in editable mode
make
source venv/bin/activate
-
Use sphinx to make documentation. The base template files are given in the
docs
folder. Refer them. Some sources for errors in sphinx - sphinx-docs, fix 1.- create docs:
sphinx-quickstart docs
- say yes to this:
> Separate source and build directories (y/n) [n]: y
- Then
cd docs sphinx-build -b html source/ build/html sphinx-apidoc -o source/ ../myproj --force make html
- Add these to
docs/source/conf.py
for Google style documentation. See example here.
extensions = [ 'sphinx.ext.duration', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon' ] # Napoleon settings napoleon_google_docstring = True napoleon_numpy_docstring = False napoleon_include_init_with_doc = False napoleon_include_private_with_doc = False napoleon_include_special_with_doc = True napoleon_use_admonition_for_examples = False napoleon_use_admonition_for_notes = False napoleon_use_admonition_for_references = False napoleon_use_ivar = False napoleon_use_param = True napoleon_use_rtype = True napoleon_preprocess_types = False napoleon_type_aliases = None napoleon_attr_annotations = True # Documentation theme html_theme = 'furo'
-
Add any other specification command to Makefile.
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
jais-0.0.1.9.tar.gz
(43.8 kB
view hashes)
Built Distribution
jais-0.0.1.9-py3-none-any.whl
(25.1 kB
view hashes)