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.

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

oneAPI CCL documentation bug-fix in sample example for cpu #1636

Open
tygoetsch opened this issue May 9, 2023 · 0 comments
Open

oneAPI CCL documentation bug-fix in sample example for cpu #1636

tygoetsch opened this issue May 9, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tygoetsch
Copy link

Summary

Sample code for testing CCL has a typo. When setting --ccl-configuration=cpu on the first line of the code block, cpu is not a valid option:

source ${ONEAPI_ROOT}/setvars.sh --ccl-configuration=cpu

cd oneapi-toolkit/oneCCL/oneCCL_Getting_Started
mkdir build
cd build
cmake .. -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++
make cpu_allreduce_test

Pulled from ccl's env/vars.sh script, it looks like cpu_icc is the correct choice for CPU-only:

case "$ccl_configuration" in
    cpu_gpu_dpcpp|cpu_icc)
        ;;
    *)
    echo "Warning: ccl-configuration=${ccl_configuration} is incorrect"
    echo "Warning: ccl-configuration will be set to ${DEFAULT_CONFIGURATION}"
    ccl_configuration="${DEFAULT_CONFIGURATION}"
        ;;
esac

URLs

https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneCCL/oneCCL_Getting_Started#on-a-linux-system

Additional details

Replace --ccl-configuration=cpu with --ccl-configuration=cpu_icc on the first line of the code block mentioned above.

@tygoetsch tygoetsch added the documentation Improvements or additions to documentation label May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant