diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 000000000..15b280a1f --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,22 @@ +name: lint +on: + # check on PRs, and manual triggers + pull_request: + paths: + - '**.py' + - 'requirements.txt' + - '.github/workflows/*.yml' + - "*.md" + workflow_dispatch: + +jobs: + pre-commit: + name: pre-commit + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: "3.9" + cache: 'pip' # caching pip dependencies + - uses: pre-commit/action@v3.0.0 diff --git a/README.md b/README.md index c9731ad70..2bd3d5281 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,9 @@ accelerate launch -m axolotl.cli.inference examples/openllama-3b/lora.yml \ docker compose up -d ``` +>[!Tip] +> If you want to debug axolotl or prefer to use Docker as your development environment, see the [debugging guide's section on Docker](docs/debugging.md#debugging-with-docker). +
Docker advanced diff --git a/docs/debugging.md b/docs/debugging.md index ad66493a1..920a8c005 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -182,7 +182,7 @@ style="border-radius: 10px; display: block; margin: auto;" width="560" height="3 ## Debugging With Docker -Using [official Axolotl Docker images](https://hub.docker.com/r/winglian/axolotl/tags) is a great way to debug your code, and is a very popular way to use Axolotl. Attaching VSCode to Docker takes a few more steps. +Using [official Axolotl Docker images](https://hub.docker.com/r/winglian/axolotl/tags) is a great way to debug your code, and is a very popular way to use Axolotl. Attaching VSCode to Docker takes a few more steps. ### Setup @@ -218,7 +218,7 @@ Next, if you are using a remote host, [Remote into this host with VSCode](https: Next, select `Dev Containers: Attach to Running Container...` using the command palette (`CMD + SHIFT + P`) in VSCode. You will be prompted to select a container to attach to. Select the container you just created. You will now be in the container with a working directory that is at the root of the project. Any changes you make to the code will be reflected both in the container and on the host. -Now you are ready to debug as described above (see [Debugging with VSCode](#debugging-with-vscode)). +Now you are ready to debug as described above (see [Debugging with VSCode](#debugging-with-vscode)). ### Video - Attaching To Docker On Remote Host