RainbowNeko Engine
Introduction
RainbowNeko Engine is a toolbox for pytorch based neural network training and inference. Multiple tasks and training strategies are built-in and highly expandable.
Install
-
Install pytorch
-
Install with pip:
pip install rainbowneko
or Install from source:
git clone https://github.com/IrisRainbowNeko/RainbowNekoEngine.git
cd RainbowNekoEngine
pip install -e .
- To use xFormers to reduce VRAM usage and accelerate training:
# use conda
conda install xformers -c xformers
# use pip
pip install xformers>=0.0.17
User guidance
Start a new project
mkdir my_project
cd my_project
# Modified based on this project or start a new project and make initialization
nekoinit
Training
Training scripts based on 🤗 Accelerate or Colossal-AI are provided.
- For 🤗 Accelerate, you may need to configure the environment before launching the scripts.
- For Colossal-AI, you can use torchrun to launch the scripts.
# with Accelerate
neko_train --cfg cfgs/train/cfg_file.py
# with Accelerate and only one GPU
neko_train_1gpu --cfg cfgs/train/cfg_file.py
Inference
RainbowNeko Engine inference with workflow configuration file.
neko_run --cfg cfgs/infer/cfg_file.py
Tutorials
Contributing
You are welcome to contribute more models and features to this toolbox!
1 maintainer
Metadata
1 maintainer
Release files for rainbowneko 1.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rainbowneko-1.10.0.tar.gz | 109.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rainbowneko-1.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 273.0 kB
Release files / rainbowneko-1.10.0.tar.gz
| Download URL | rainbowneko-1.10.0.tar.gz |
|---|---|
| Size | 109.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b48fb905214a3b6b58d3d14b716f820aa86650d3d129daf727365ccea486b2b3
|
|
BLAKE2b-256 checksum How to use checksums |
3659108b551c3188937ff0ab46a07bc674ef6f44199e46860aa31c0b7cf1cf22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / rainbowneko-1.10.0-py3-none-any.whl
| Download URL | rainbowneko-1.10.0-py3-none-any.whl |
|---|---|
| Size | 163.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
99efb60002f3b40498ba646262f08c0fd0f46d2a5445c8f57db528838ed4337f
|
|
BLAKE2b-256 checksum How to use checksums |
b6a6df51bc1eaa8b49143b7312e9d87b390595479ab3ace63d98a3530192f37a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
