Skip to content

Commit

Permalink
DOCS-modin-project#1816: Add notes about using MODIN_SOCKS_PROXY vari…
Browse files Browse the repository at this point in the history
…able

Co-authored-by: Vasily Litvinov <45396231+vnlitvinov@users.noreply.github.com>

Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
  • Loading branch information
anmyachev committed Jul 28, 2020
1 parent cac75c0 commit 70d4421
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions modin/experimental/cloud/cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,14 @@ def create(
The object that knows how to destroy the cluster and how to activate it as remote context.
Note that by default spawning and destroying of the cluster happens in the background,
as it's usually a rather lengthy process.
Notes
-----
Cluster computation actually can work when proxies are required to access the cloud.
You should set normal "http_proxy"/"https_proxy" variables for HTTP/HTTPS proxies and
set "MODIN_SOCKS_PROXY" variable for SOCKS proxy before calling the function.
Using SOCKS proxy requires Ray newer than 0.8.6, which might need to be installed manually.
"""
if not isinstance(provider, Provider):
provider = Provider(
Expand Down

0 comments on commit 70d4421

Please sign in to comment.