Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add link on README to Docker Debugging #1107

Merged
merged 11 commits into from
Jan 12, 2024
Merged

Add link on README to Docker Debugging #1107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f4d0f72
add docker debug
hamelsmu Jan 12, 2024
35d555c
Update docs/debugging.md
hamelsmu Jan 12, 2024
503cc96
explain editable install
hamelsmu Jan 12, 2024
fd9585c
explain editable install
hamelsmu Jan 12, 2024
53f96ac
upload new video
hamelsmu Jan 12, 2024
cc66147
add link to README
hamelsmu Jan 12, 2024
bfcd441
Merge branch 'main' into docker-debug
hamelsmu Jan 12, 2024
2f9eb76
Update README.md
hamelsmu Jan 12, 2024
506bade
Update README.md
hamelsmu Jan 12, 2024
fecb941
chore: lint
winglian Jan 12, 2024
bb1964c
make sure to lint markdown too
winglian Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/[email protected]
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Comment on lines +135 to +137
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this section be put under the "Contributing section"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think lots of times people use docker to debug stuff and they may not think of contributing

At least all the questions I got were people wanting to debug but not necessarily contribute

We take for granted that people want to open PRs so I put this here to get people further into the funnel of debugging their issues

<details>

<summary>Docker advanced</summary>
Expand Down
4 changes: 2 additions & 2 deletions docs/debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading