• moto's avatar
    Fix prototype exclusion in release (#2225) · a007e922
    moto authored
    Summary:
    This commit fixes the feature to exclude `torchaudio.prototype` module.
    
    In `setup.py` there is a special case that is triggered if the commit is on release branch or release tag, that  excludes `torchaudio.prototype`. This was introduced to make it easy for release-related work.
    It turned out that the submodules under `torchaudio.prototype`, such as `torchaudio.prototype.pipelines`, are not properly excluded from packaging.
    These sub modules did not exist in previous releases, so it was not an issue.
    
    **Note** This feature is triggered only in release branch, so the fix is not visible in the CI of this PR.
    https://app.circleci.com/pipelines/github/pytorch/audio/9674/workflows/d0c9a6f1-8ca9-441a-a5f5-08926075fa39/jobs/553985?invite=true#step-104-193
    
    The following outputs were observed when running it on local env.
    
    * Before the change
    
    ```
    $ BUILD_FFMPEG=0 BUILD_SOX=0 BUILD_CTC_DECODER=0 BUILD_RNNT=0 BUILD_KALDI=0 python setup.py clean bdist_wheel
    ```
    ```
    -- Git branch: prototype-exclusion
    -- Git SHA: 0af1edaa420c46be10292cbea7150c34ef80a0e1
    -- Git tag: None
    -- PyTorch dependency: torch
    -- Building version 0.11.0+0af1eda
     --- Initializing submodules
     --- Initialized submodule
    Excluding torchaudio.prototype from the package.
    ...
    creating build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype
    creating build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/io
    copying torchaudio/prototype/io/streamer.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/io
    copying torchaudio/prototype/io/__init__.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/io
    creating build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/pipelines
    copying torchaudio/prototype/pipelines/__init__.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/pipelines
    copying torchaudio/prototype/pipelines/rnnt_pipeline.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/pipelines
    creating build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/ctc_decoder
    copying torchaudio/prototype/ctc_decoder/ctc_decoder.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/ctc_decoder
    copying torchaudio/prototype/ctc_decoder/__init__.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/prototype/ctc_decoder
    warning: build_py: byte-compiling is disabled, skipping.
    ```
    
    * After the change
    
    ```
    $ BUILD_FFMPEG=0 BUILD_SOX=0 BUILD_CTC_DECODER=0 BUILD_RNNT=0 BUILD_KALDI=0 python setup.py clean bdist_wheel
    ```
    
    ```
    -- Git branch: prototype-exclusion
    -- Git SHA: 0af1edaa420c46be10292cbea7150c34ef80a0e1
    -- Git tag: None
    -- PyTorch dependency: torch
    -- Building version 0.11.0+0af1eda
     --- Initializing submodules
     --- Initialized submodule
    Excluding torchaudio.prototype from the package.
    ...
    creating build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2
    copying torchaudio/models/wav2vec2/__init__.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2
    copying torchaudio/models/wav2vec2/model.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2
    copying torchaudio/models/wav2vec2/components.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2
    creating build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2/utils
    copying torchaudio/models/wav2vec2/utils/__init__.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2/utils
    copying torchaudio/models/wav2vec2/utils/import_huggingface.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2/utils
    copying torchaudio/models/wav2vec2/utils/import_fairseq.py -> build/lib.macosx-11.0-arm64-3.9/torchaudio/models/wav2vec2/utils
    warning: build_py: byte-compiling is disabled, skipping.
    ```
    
    Pull Request resolved: https://github.com/pytorch/audio/pull/2225
    
    Reviewed By: nateanl
    
    Differential Revision: D34257128
    
    Pulled By: mthrok
    
    fbshipit-source-id: a3d6eca5803356e5aa3fe0eda82f6a9f5affb8e8
    a007e922
setup.py 5.48 KB