-
Notifications
You must be signed in to change notification settings - Fork 33
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.
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 quickstart instructions for iree_tests #306
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -1,5 +1,39 @@ | ||||||||||
# IREE Tests | ||||||||||
|
||||||||||
## Quickstart instructions | ||||||||||
|
||||||||||
``` | ||||||||||
#!/bin/bash | ||||||||||
Comment on lines
+5
to
+6
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: add an explicit language when known to code blocks, to help markdown renderers apply syntax highlighting
Suggested change
|
||||||||||
set -e | ||||||||||
|
||||||||||
cd ~/SHARK-TestSuite/ | ||||||||||
|
||||||||||
# Create and activate a virtual environment | ||||||||||
python3 -m venv .venv | ||||||||||
source .venv/bin/activate | ||||||||||
|
||||||||||
# Install required packages | ||||||||||
pip install -r iree_tests/requirements.txt | ||||||||||
pip install ./common_tools/ | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm considering folding |
||||||||||
|
||||||||||
# Optional: Install IREE compiler and runtime if you don't want to use a local copy | ||||||||||
# pip install --find-links https://iree.dev/pip-release-links.html iree-compiler iree-runtime --upgrade | ||||||||||
|
||||||||||
# Install Git LFS | ||||||||||
git lfs install | ||||||||||
Comment on lines
+22
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It helps to run this before cloning the repo IIRC. I'm not sure if installing git lfs will automatically fetch blobs if you had previously cloned/fetched without git lfs. |
||||||||||
|
||||||||||
# Optional: Download large remote files required for certain tests | ||||||||||
# python download_remote_files.py | ||||||||||
|
||||||||||
# Run a simple test to verify setup | ||||||||||
pytest iree_tests/simple | ||||||||||
|
||||||||||
echo "Setup complete! You can now run IREE tests." | ||||||||||
echo "Example: pytest iree_tests -n auto" | ||||||||||
Comment on lines
+31
to
+32
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We rarely ever run all tests with the same config file. Consider the simple case of CPU:
The ONNX tests run single threaded ( I'd put a command here that is expected to work out of the box. Maybe something more like |
||||||||||
``` | ||||||||||
|
||||||||||
## About | ||||||||||
|
||||||||||
This directory contains generated test suites for running through IREE's | ||||||||||
compiler and runtime tools. | ||||||||||
|
||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This duplicates the setup at https://github.com/nod-ai/SHARK-TestSuite/tree/main/iree_tests#common-venv-setup-with-deps . Want to merge the two?
$PATH
vs python packages