You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by gu...@apache.org on 2023/04/17 06:00:25 UTC

[spark] branch master updated: [SPARK-43151][DOC] Update the prerequisites for generating Python API docs

This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new 64841187ca0 [SPARK-43151][DOC] Update the prerequisites for generating Python API docs
64841187ca0 is described below

commit 64841187ca0216f07bf566bb1432fc9f0c2ef8f2
Author: Gengliang Wang <ge...@apache.org>
AuthorDate: Mon Apr 17 15:00:11 2023 +0900

    [SPARK-43151][DOC] Update the prerequisites for generating Python API docs
    
    ### What changes were proposed in this pull request?
    
    Update the prerequisites for generating Python API docs:
    * The command should be run under the docs directory so that the input file should be `../dev/requirements.txt`
    * Remove `sudo` in the command
    * Remove the version for `torch` and `torchvision`. I was getting
    
    ```
    ERROR: Could not find a version that satisfies the requirement torch==1.13.1 (from versions: 2.0.0)
    ERROR: No matching distribution found for torch==1.13.1
    ERROR: Could not find a version that satisfies the requirement torchvision==0.14.1
    ```
    
    ### Why are the changes needed?
    
    Update the prerequisites for generating Python API docs, to save troubles from other developers when generating Python Docs.
    
    ### Does this PR introduce _any_ user-facing change?
    
    No
    ### How was this patch tested?
    
    Manually try the command and new requirements.txt
    
    Closes #40804 from gengliangwang/updatePyInstall.
    
    Authored-by: Gengliang Wang <ge...@apache.org>
    Signed-off-by: Hyukjin Kwon <gu...@apache.org>
---
 dev/requirements.txt | 4 ++--
 docs/README.md       | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/dev/requirements.txt b/dev/requirements.txt
index c54c5ea770c..8b697109d2b 100644
--- a/dev/requirements.txt
+++ b/dev/requirements.txt
@@ -61,5 +61,5 @@ googleapis-common-protos-stubs==2.2.0
 grpc-stubs==1.24.11
 
 # TorchDistributor dependencies
-torch==1.13.1
-torchvision==0.14.1
+torch
+torchvision
diff --git a/docs/README.md b/docs/README.md
index 4b788dbc79d..87d68c2f864 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -61,7 +61,7 @@ See also https://issues.apache.org/jira/browse/SPARK-35375.
 -->
 Run the following command from $SPARK_HOME:
 ```sh
-$ sudo pip install --upgrade -r dev/requirements.txt
+$ pip install --upgrade -r dev/requirements.txt
 ```
 
 ### R API Documentation (Optional)


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org