Skip to content

Troubleshooting guide #127

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Troubleshooting guide #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3ead1c
feat: troubleshooting doc
Dec 8, 2024
dca1f32
troubleshooting page to getting started
Dec 8, 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
21 changes: 21 additions & 0 deletions docs/misc/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Troubleshooting

The Bazel build system should install all necessary dependencies including `llvm` and `zig`. Issues can arise from conflicts with local toolchains.

## MacOS

Useful Bazel commands:

- `bazel fetch --force --configure`: this will refetch and configure local sandbox for external toolchains.
- `bazel clean --expunge`: this will remove all downloaded dependencies and start fresh.

Make sure that your MacOS is up to date. There is a known issue with `14.7`.

Verify the existance of the Xcode CLI developer tools: `xcode-select --install`.
Reinstall the CLT:

```bash
sudo rm -rf /Library/Developer/CommandLineTools && \
sudo xcode-select -r && \
sudo xcode-select --install
```
3 changes: 3 additions & 0 deletions docs/tutorials/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ bazel run -c opt //llama:OpenLLaMA-3B \
-- --prompt="Once upon a time,"
```

## Troubleshooting

If you run into trouble in the setup process, please check out the [Troubleshooting](../misc/troubleshooting.md) guide.

## Where to go next:

Expand Down