Skip to content

Support dpctl in virtual environment on Windows out of the box #1922

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

Merged
oleksandr-pavlyk merged 4 commits into from
Dec 7, 2024
Merged

Support dpctl in virtual environment on Windows out of the box #1922

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9cdc8e4
Support dpctl in vritual environment out of the box
oleksandr-pavlyk Dec 4, 2024
d8bc19e
Update dpctl/_init_helper.py
oleksandr-pavlyk Dec 5, 2024
eab51fd
More robust check that VIRUAL_ENV is valid
oleksandr-pavlyk Dec 6, 2024
c6eea90
Avoid reliance of VIRTUAL_ENV environment variable
oleksandr-pavlyk Dec 6, 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
Next Next commit
Support dpctl in vritual environment out of the box 
Since location of Library\bin in virtual environment is not on
the default search path, importing of dpctl failes due to unmet
dependencies for native extensions of dpctl submodules.

This change introduces _init_helper.py which implements the following
logic using built-in os Python module:

1. If os.add_dll_directory exists, and VIRTUAL_ENV environment variable
   is set, and os.path.join(os.environ["VIRTUAL_ENV"], "Library", "bin")
   exists, call os.add_dll_directory with that directory.

With this change the gh-1745 is fixed, and "python -m dpctl -f" works
out of the box.

Only GPU devices are visible, and to enable CPU device two additional
steps must be performed:

  1. Edit %VIRUAL_ENV%\Library\bin\cl.cfg and set CL_CONFIG_TBB_DLL_PATH
     variable at the bottom of the configuration file to the expanded
     value of %VIRUAL_ENV%\Library\bin\tbb12.dll but use forward slashes,
     instead of native backward slashes.
  2. Append %VIRUAL_ENV%\Library\bin to the PATH using
     `set "PATH=%PATH%:%VIRTUAL_ENV%\Library\bin"`

After these changes `python -m dpctl -f` should see CPU device.
  • Loading branch information
@oleksandr-pavlyk
oleksandr-pavlyk committed Dec 4, 2024
commit 9cdc8e4b9c5edc03ce7bae12720747e21ed7efbc
2 changes: 2 additions & 0 deletions dpctl/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import os
import os.path

from . import _init_helper
from ._device_selection import select_device_with_aspects
from ._sycl_context import SyclContext, SyclContextCreationError
from ._sycl_device import (
Expand Down Expand Up @@ -137,3 +138,4 @@ def get_include():

__version__ = get_versions()["version"]
del get_versions
del _init_helper
27 changes: 27 additions & 0 deletions dpctl/_init_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Data Parallel Control (dpctl)
#
# Copyright 2020-2024 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import os.path

if hasattr(os, "add_dll_directory"):
# For virtual environments on Windows, add folder
# with DPC++ libraries to the DLL search path gh-1745
if "VIRTUAL_ENV" in os.environ:
venv_dir = os.environ["VIRTUAL_ENV"]
expected_dir = os.path.join(venv_dir, "Library", "bin")
if os.exists(expected_dir):
Comment thread
oleksandr-pavlyk marked this conversation as resolved.
Outdated
os.add_dll_directory(expected_dir)