SMILE-factory

(โ˜… 106)

Finetune Falcon, LLaMA, MPT, and RedPajama on consumer hardware using PEFT LoRA

  • .env.example
  • .gitignore
  • .pre-commit-config.yaml
  • AGENTS.md
  • ARCHITECTURE.md
  • CLAUDE.md
  • LICENSE
  • Makefile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/leehanchung/SMILE-factory

Downloads the entire project code from GitHub to your computer.

cd SMILE-factory

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
apt update && apt install -y docker.io git

Type this command into your terminal and run it.

systemctl enable --now docker

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

โœ… If it runs without errors and prints output in the terminal, it worked.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make deploy-modal

Compiles the code based on the generated build configuration to produce an executable.

make -C apps/delulu_sandbox_modal modal-deploy

Compiles the code based on the generated build configuration to produce an executable.

make -C apps/delulu_discord deploy # = image + restart

Compiles the code based on the generated build configuration to produce an executable.

make -C apps/delulu_discord logs # tail the container

Compiles the code based on the generated build configuration to produce an executable.

make -C apps/delulu_discord deploy ENV_FILE=$PWD/apps/delulu_discord/.env MODAL_TOML=$HOME/.modal.toml

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation