config.yml.in 29.1 KB
Newer Older
1
2
3
4
version: 2.1

# How to test the Linux jobs:
#   - Install CircleCI local CLI: https://circleci.com/docs/2.0/local-cli/
5
6
#   - circleci config process .circleci/config.yml > gen.yml && circleci local execute -c gen.yml --job binary_linux_wheel_py3.8
#     - Replace binary_linux_wheel_py3.8 with the name of the job you want to test.
Edward Z. Yang's avatar
Edward Z. Yang committed
7
#       Job names are 'name:' key.
8

9
10
11
12
13
14
executors:
  windows-cpu:
    machine:
      resource_class: windows.xlarge
      image: windows-server-2019-vs2019:stable
      shell: bash.exe
peterjc123's avatar
peterjc123 committed
15

16
17
18
  windows-gpu:
    machine:
      resource_class: windows.gpu.nvidia.medium
19
      image: windows-server-2019-nvidia:stable
20
21
      shell: bash.exe

22
commands:
23
24
25
26
27
28
  generate_cache_key:
    description: "Generates a cache key file that changes daily"
    steps:
      - run:
          name: Generate cache key
          command: echo "$(date +"%Y-%m-%d")" > .cachekey
29
30
31
32
33
34
35
36
  designate_upload_channel:
    description: "inserts the correct upload channel into ${BASH_ENV}"
    steps:
      - run:
          name: adding UPLOAD_CHANNEL to BASH_ENV
          command: |
            our_upload_channel=nightly
            # On tags upload to test instead
37
            if [[ -n "${CIRCLE_TAG}" ]] || [[ ${CIRCLE_BRANCH} =~ release/* ]]; then
38
39
40
              our_upload_channel=test
            fi
            echo "export UPLOAD_CHANNEL=${our_upload_channel}" >> ${BASH_ENV}
Eli Uriegas's avatar
Eli Uriegas committed
41
42
43
44
45
46
47
  load_conda_channel_flags:
    description: "Determines whether we need extra conda channels"
    steps:
      - run:
          name: Adding CONDA_CHANNEL_FLAGS to BASH_ENV
          command: |
              CONDA_CHANNEL_FLAGS=""
48
              # formerly used to add conda-forge flags for Python 3.9, reserving the mechanism for future python upgrades
49
50
51
52
53
54
55
  windows_install_cuda:
    description: "Install desired CUDA version on Windows runners"
    steps:
      - run:
          name: Install CUDA
          command: |
              packaging/windows/internal/cuda_install.bat
56

57
58
binary_common: &binary_common
  parameters:
Edward Z. Yang's avatar
Edward Z. Yang committed
59
    # Edit these defaults to do a release
60
61
62
63
64
65
66
67
68
69
    build_version:
      description: "version number of release binary; by default, build a nightly"
      type: string
      default: ""
    pytorch_version:
      description: "PyTorch version to build against; by default, use a nightly"
      type: string
      default: ""
    # Don't edit these
    python_version:
70
      description: "Python version to build against (e.g., 3.8)"
71
      type: string
Nikita Shulga's avatar
Nikita Shulga committed
72
73
74
75
76
77
78
79
80
81
82
83
    cuda_version:
      description: "CUDA version to build against (e.g., cpu, cu101)"
      type: string
      default: "cpu"
    wheel_docker_image:
      description: "Wheel only: what docker image to use"
      type: string
      default: "pytorch/manylinux-cuda102"
    conda_docker_image:
      description: "Conda only: what docker image to use"
      type: string
      default: "pytorch/conda-builder:cuda102"
84
  environment: &environment
85
86
87
    PYTHON_VERSION: << parameters.python_version >>
    BUILD_VERSION: << parameters.build_version >>
    PYTORCH_VERSION: << parameters.pytorch_version >>
Nikita Shulga's avatar
Nikita Shulga committed
88
    CU_VERSION: << parameters.cuda_version >>
89

Mingbo Wan's avatar
Mingbo Wan committed
90
91
92
smoke_test_common: &smoke_test_common
  <<: *binary_common
  docker:
93
    - image: pytorch/torchaudio_unittest_base:smoke_test-20220425
Caroline Chen's avatar
Caroline Chen committed
94
  resource_class: large
Mingbo Wan's avatar
Mingbo Wan committed
95

96
97
98
jobs:
  circleci_consistency:
    docker:
moto's avatar
moto committed
99
      - image: cimg/python:3.8
100
101
102
103
    steps:
      - checkout
      - run:
          command: |
104
            pip install --user --progress-bar off jinja2 pyyaml
105
106
107
            python .circleci/regenerate.py
            git diff --exit-code || (echo ".circleci/config.yml not in sync with config.yml.in! Run .circleci/regenerate.py to update config"; exit 1)

108
109
110
111
112
113
114
115
116
117
118
119
120
  lint_python_and_config:
    docker:
      - image: circleci/python:3.7
    steps:
      - checkout
      - run:
          name: Install pre-commit
          command: pip install --user --progress-bar off pre-commit
      - run:
          name: Install pre-commit hooks
          command: pre-commit install-hooks
      - run:
          name: Lint Python code and config files
121
          command: pre-commit run --all-files
122
123
      - run:
          name: Required lint modifications
124
          when: always
moto's avatar
moto committed
125
          command: git --no-pager diff --color=always
126

127
  download_third_parties:
128
    docker:
moto's avatar
moto committed
129
      - image: "pytorch/torchaudio_unittest_base:manylinux"
130
131
132
    resource_class: small
    steps:
      - checkout
133
      - generate_cache_key
134
135
136
      - restore_cache:
          {% raw %}
          keys:
moto's avatar
moto committed
137
            - tp-nix-v2-{{ checksum ".cachekey" }}
138
139
          {% endraw %}
      - run:
moto's avatar
moto committed
140
          command: |
141
142
              mkdir -p third_party/archives/
              wget --no-clobber --directory-prefix=third_party/archives/ $(awk '/URL /{print $2}' third_party/*/CMakeLists.txt)
143
144
      - save_cache:
          {% raw %}
moto's avatar
moto committed
145
          key: tp-nix-v2-{{ checksum ".cachekey" }}
146
147
          {% endraw %}
          paths:
148
            - third_party/archives
149
150
151
      - persist_to_workspace:
          root: third_party
          paths:
152
            - archives
153

154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
  build_ffmpeg_linux:
    <<: *binary_common
    docker:
      - image: << parameters.wheel_docker_image >>
    resource_class: 2xlarge+
    steps:
      - checkout
      - generate_cache_key
      - restore_cache:
          {% raw %}
          keys:
            - ffmpeg-linux-v0-{{ checksum ".cachekey" }}
          {% endraw %}
      - run:
          command: |
            export FFMPEG_ROOT=${PWD}/third_party/ffmpeg
            if [[ ! -d ${FFMPEG_ROOT} ]]; then
                packaging/ffmpeg/build.sh
            fi
      - save_cache:
          {% raw %}
          key: ffmpeg-linux-v0-{{ checksum ".cachekey" }}
          {% endraw %}
          paths:
            - third_party/ffmpeg
      - persist_to_workspace:
          root: third_party
          paths:
            - ffmpeg

  build_ffmpeg_macos:
    <<: *binary_common
    macos:
      xcode: "12.0"
    steps:
      - checkout
      - generate_cache_key
      - restore_cache:
          {% raw %}
          keys:
            - ffmpeg-macos-v0-{{ checksum ".cachekey" }}
          {% endraw %}
      - run:
          command: |
            export FFMPEG_ROOT=${PWD}/third_party/ffmpeg
            if [[ ! -d ${FFMPEG_ROOT} ]]; then
                packaging/ffmpeg/build.sh
            fi
      - save_cache:
          {% raw %}
          key: ffmpeg-macos-v0-{{ checksum ".cachekey" }}
          {% endraw %}
          paths:
            - third_party/ffmpeg
      - persist_to_workspace:
          root: third_party
          paths:
            - ffmpeg

  build_ffmpeg_windows:
    <<: *binary_common
    machine:
      resource_class: windows.xlarge
      image: windows-server-2019-vs2019:stable
      # Note:
      # Unlike other Windows job, this job uses cmd.exe as shell because
      # we need to invoke bash.exe from msys2 in ffmpeg build process, and doing so
      # from different installation of bash.exe (the one from the VM) cause issue
      shell: cmd.exe
    steps:
      - checkout
      - run: date /t > .cachekey
      - restore_cache:
          {% raw %}
          keys:
            - ffmpeg-windows-{{ checksum ".cachekey" }}
          {% endraw %}
      - run: packaging\ffmpeg\build.bat
      - save_cache:
          {% raw %}
          key: ffmpeg-windows-{{ checksum ".cachekey" }}
          {% endraw %}
          paths:
            - third_party/ffmpeg
      - persist_to_workspace:
          root: third_party
          paths:
            - ffmpeg

243
244
245
  binary_linux_wheel:
    <<: *binary_common
    docker:
Nikita Shulga's avatar
Nikita Shulga committed
246
      - image: << parameters.wheel_docker_image >>
247
248
249
    resource_class: 2xlarge+
    steps:
      - checkout
250
251
      - attach_workspace:
          at: third_party
252
253
      - run:
          command: |
254
            export FFMPEG_ROOT=${PWD}/third_party/ffmpeg
255
            packaging/build_wheel.sh
256
          environment:
257
            USE_FFMPEG: true
258
259
      - store_artifacts:
          path: dist
Edward Z. Yang's avatar
Edward Z. Yang committed
260
261
262
263
      - persist_to_workspace:
          root: dist
          paths:
            - "*"
264
265
266
267

  binary_linux_conda:
    <<: *binary_common
    docker:
Nikita Shulga's avatar
Nikita Shulga committed
268
      - image: "<< parameters.conda_docker_image >>"
269
270
271
    resource_class: 2xlarge+
    steps:
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
272
      - load_conda_channel_flags
273
274
      - attach_workspace:
          at: third_party
275
      - run:
276
277
278
          command: |
            export FFMPEG_ROOT=${PWD}/third_party/ffmpeg
            packaging/build_conda.sh
279
          environment:
280
            USE_FFMPEG: true
281
282
      - store_artifacts:
          path: /opt/conda/conda-bld/linux-64
Edward Z. Yang's avatar
Edward Z. Yang committed
283
      - persist_to_workspace:
284
          root: /opt/conda
Edward Z. Yang's avatar
Edward Z. Yang committed
285
          paths:
286
            - "conda-bld/*"
287
288
289
290

  binary_macos_wheel:
    <<: *binary_common
    macos:
291
      xcode: "12.0"
292
293
    steps:
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
294
      - load_conda_channel_flags
295
296
      - attach_workspace:
          at: third_party
297
298
299
300
301
302
303
304
      - run:
          # Cannot easily deduplicate this as source'ing activate
          # will set environment variables which we need to propagate
          # to build_wheel.sh
          command: |
            curl -o conda.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh
            sh conda.sh -b
            source $HOME/miniconda3/bin/activate
305
            export FFMPEG_ROOT="${PWD}/third_party/ffmpeg"
306
            packaging/build_wheel.sh
307
          environment:
308
            USE_FFMPEG: true
309
310
      - store_artifacts:
          path: dist
Edward Z. Yang's avatar
Edward Z. Yang committed
311
312
313
314
      - persist_to_workspace:
          root: dist
          paths:
            - "*"
315
316
317
318

  binary_macos_conda:
    <<: *binary_common
    macos:
319
      xcode: "12.0"
320
321
    steps:
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
322
      - load_conda_channel_flags
323
324
      - attach_workspace:
          at: third_party
325
326
327
328
329
330
      - run:
          command: |
            curl -o conda.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh
            sh conda.sh -b
            source $HOME/miniconda3/bin/activate
            conda install -yq conda-build
331
            export FFMPEG_ROOT="${PWD}/third_party/ffmpeg"
332
            packaging/build_conda.sh
333
          environment:
334
            USE_FFMPEG: true
335
336
      - store_artifacts:
          path: /Users/distiller/miniconda3/conda-bld/osx-64
Edward Z. Yang's avatar
Edward Z. Yang committed
337
      - persist_to_workspace:
338
          root: /Users/distiller/miniconda3
Edward Z. Yang's avatar
Edward Z. Yang committed
339
          paths:
340
            - "conda-bld/*"
341

peterjc123's avatar
peterjc123 committed
342
343
344
345
346
347
  binary_windows_wheel:
    <<: *binary_common
    executor:
      name: windows-cpu
    steps:
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
348
      - load_conda_channel_flags
349
      - windows_install_cuda
350
351
      - attach_workspace:
          at: third_party
peterjc123's avatar
peterjc123 committed
352
      - run:
353
          name: Build wheel packages
peterjc123's avatar
peterjc123 committed
354
          command: |
355
            set -ex
peterjc123's avatar
peterjc123 committed
356
357
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda activate base
358
            export FFMPEG_ROOT="${PWD}/third_party/ffmpeg"
peterjc123's avatar
peterjc123 committed
359
            bash packaging/build_wheel.sh
360
          environment:
361
            USE_FFMPEG: true
peterjc123's avatar
peterjc123 committed
362
363
364
365
366
367
368
369
370
371
372
373
374
      - store_artifacts:
          path: dist
      - persist_to_workspace:
          root: dist
          paths:
            - "*"

  binary_windows_conda:
    <<: *binary_common
    executor:
      name: windows-cpu
    steps:
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
375
      - load_conda_channel_flags
376
      - windows_install_cuda
377
378
      - attach_workspace:
          at: third_party
peterjc123's avatar
peterjc123 committed
379
      - run:
380
          name: Build conda packages
381
          no_output_timeout: 20m
peterjc123's avatar
peterjc123 committed
382
          command: |
383
            set -ex
peterjc123's avatar
peterjc123 committed
384
385
386
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda activate base
            conda install -yq conda-build "conda-package-handling!=1.5.0"
387
388
389
390
            # cudatoolkit >= 11 isn't available for windows in the nvidia channel
            if [[ "${CU_VERSION}" =~ cu11.* ]]; then
              export CONDA_CHANNEL_FLAGS="-c conda-forge"
            fi
391
            export FFMPEG_ROOT="${PWD}/third_party/ffmpeg"
peterjc123's avatar
peterjc123 committed
392
            bash packaging/build_conda.sh
393
          environment:
394
            USE_FFMPEG: true
peterjc123's avatar
peterjc123 committed
395
396
397
      - store_artifacts:
          path: C:/tools/miniconda3/conda-bld/win-64
      - persist_to_workspace:
398
          root: C:/tools/miniconda3
peterjc123's avatar
peterjc123 committed
399
          paths:
400
            - "conda-bld/*"
peterjc123's avatar
peterjc123 committed
401

Edward Z. Yang's avatar
Edward Z. Yang committed
402
403
404
405
406
407
408
  # Requires org-member context
  binary_conda_upload:
    docker:
      - image: continuumio/miniconda
    steps:
      - attach_workspace:
          at: ~/workspace
409
      - designate_upload_channel
Edward Z. Yang's avatar
Edward Z. Yang committed
410
411
412
413
414
      - run:
          command: |
            # Prevent credential from leaking
            conda install -yq anaconda-client
            set -x
415
            anaconda -t "${CONDA_PYTORCHBOT_TOKEN}" upload ~/workspace/conda-bld/*/*.tar.bz2 -u "pytorch-${UPLOAD_CHANNEL}" --label main --no-progress --force
Edward Z. Yang's avatar
Edward Z. Yang committed
416
417
418

  # Requires org-member context
  binary_wheel_upload:
419
420
421
422
    parameters:
      subfolder:
        description: "What whl subfolder to upload to, e.g., blank or cu100/ (trailing slash is important)"
        type: string
Edward Z. Yang's avatar
Edward Z. Yang committed
423
    docker:
moto's avatar
moto committed
424
      - image: cimg/python:3.8
Edward Z. Yang's avatar
Edward Z. Yang committed
425
426
427
428
    steps:
      - attach_workspace:
          at: ~/workspace
      - checkout
429
      - designate_upload_channel
Edward Z. Yang's avatar
Edward Z. Yang committed
430
431
432
433
434
435
436
437
438
439
      - run:
          command: |
            pip install --user awscli
            export PATH="$HOME/.local/bin:$PATH"
            # Prevent credential from leaking
            set +x
            export AWS_ACCESS_KEY_ID="${PYTORCH_BINARY_AWS_ACCESS_KEY_ID}"
            export AWS_SECRET_ACCESS_KEY="${PYTORCH_BINARY_AWS_SECRET_ACCESS_KEY}"
            set -x
            for pkg in ~/workspace/*.whl; do
440
              aws s3 cp "$pkg" "s3://pytorch/whl/${UPLOAD_CHANNEL}/<< parameters.subfolder >>" --acl public-read
Edward Z. Yang's avatar
Edward Z. Yang committed
441
442
            done

Mingbo Wan's avatar
Mingbo Wan committed
443
444
445
  smoke_test_linux_conda:
    <<: *smoke_test_common
    steps:
Mingbo Wan's avatar
Mingbo Wan committed
446
447
      - attach_workspace:
          at: ~/workspace
448
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
449
      - load_conda_channel_flags
Mingbo Wan's avatar
Mingbo Wan committed
450
      - run:
Mingbo Wan's avatar
Mingbo Wan committed
451
          name: install binaries
Mingbo Wan's avatar
Mingbo Wan committed
452
453
454
          command: |
            set -x
            source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
455
            conda install -v -y -c pytorch-${UPLOAD_CHANNEL} pytorch cpuonly
456
            conda install -v -y -c file://$HOME/workspace/conda-bld torchaudio
moto's avatar
moto committed
457
      - checkout
Mingbo Wan's avatar
Mingbo Wan committed
458
459
460
461
      - run:
          name: smoke test
          command: |
            source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
462
            conda install 'ffmpeg<5'
moto's avatar
moto committed
463
            ./test/smoke_test/run_smoke_test.sh
Mingbo Wan's avatar
Mingbo Wan committed
464

Caroline Chen's avatar
Caroline Chen committed
465
466
467
468
469
470
471
472
473
474
475
476
477
478
  smoke_test_linux_conda_gpu:
    <<: *smoke_test_common
    steps:
      - attach_workspace:
          at: ~/workspace
      - designate_upload_channel
      - load_conda_channel_flags
      - run:
          name: install binaries
          command: |
            set -x
            source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
            conda install -v -y -c pytorch-${UPLOAD_CHANNEL} pytorch cudatoolkit=${CU_VERSION:2:2}.${CU_VERSION:4} -c conda-forge
            conda install -v -y -c file://$HOME/workspace/conda-bld torchaudio
moto's avatar
moto committed
479
      - checkout
Caroline Chen's avatar
Caroline Chen committed
480
481
482
483
      - run:
          name: smoke test
          command: |
            source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
484
            conda install 'ffmpeg<5'
moto's avatar
moto committed
485
            ./test/smoke_test/run_smoke_test.sh
Caroline Chen's avatar
Caroline Chen committed
486

Mingbo Wan's avatar
Mingbo Wan committed
487
488
489
  smoke_test_linux_pip:
    <<: *smoke_test_common
    steps:
Mingbo Wan's avatar
Mingbo Wan committed
490
491
      - attach_workspace:
          at: ~/workspace
492
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
493
      - load_conda_channel_flags
Mingbo Wan's avatar
Mingbo Wan committed
494
      - run:
Mingbo Wan's avatar
Mingbo Wan committed
495
          name: install binaries
Mingbo Wan's avatar
Mingbo Wan committed
496
497
498
          command: |
            set -x
            source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
Caroline Chen's avatar
Caroline Chen committed
499
            pip install $(ls ~/workspace/torchaudio*.whl) -f "https://download.pytorch.org/whl/${UPLOAD_CHANNEL}/${CU_VERSION}/torch_${UPLOAD_CHANNEL}.html"
moto's avatar
moto committed
500
      - checkout
Mingbo Wan's avatar
Mingbo Wan committed
501
502
503
504
      - run:
          name: smoke test
          command: |
            source /usr/local/etc/profile.d/conda.sh && conda activate python${PYTHON_VERSION}
505
            export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${HOME}/workspace/ffmpeg/lib"
moto's avatar
moto committed
506
            ./test/smoke_test/run_smoke_test.sh
Mingbo Wan's avatar
Mingbo Wan committed
507

508
509
510
511
512
513
514
  smoke_test_windows_conda:
    <<: *binary_common
    executor:
      name: windows-cpu
    steps:
      - attach_workspace:
          at: ~/workspace
515
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
516
      - load_conda_channel_flags
517
518
519
520
521
522
523
524
      - run:
          name: install binaries
          command: |
            set -x
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda env remove -n python${PYTHON_VERSION} || true
            conda create -yn python${PYTHON_VERSION} python=${PYTHON_VERSION}
            conda activate python${PYTHON_VERSION}
525
            conda install -v -y -c pytorch-${UPLOAD_CHANNEL} pytorch cpuonly
526
            conda install -v -y $(ls ~/workspace/conda-bld/win-64/torchaudio*.tar.bz2)
moto's avatar
moto committed
527
      - checkout
528
529
530
531
532
      - run:
          name: smoke test
          command: |
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda activate python${PYTHON_VERSION}
533
            conda install 'ffmpeg<5'
moto's avatar
moto committed
534
            ./test/smoke_test/run_smoke_test.sh
535

536
537
538
539
540
  smoke_test_windows_conda_gpu:
    <<: *binary_common
    executor:
      name: windows-gpu
    steps:
Andrey Talman's avatar
Andrey Talman committed
541
      - checkout
542
543
544
545
      - attach_workspace:
          at: ~/workspace
      - designate_upload_channel
      - load_conda_channel_flags
Andrey Talman's avatar
Andrey Talman committed
546
547
548
549
      - windows_install_cuda
      - run:
          name: Update CUDA driver
          command: packaging/windows/internal/driver_update.bat
550
551
      - run:
          name: install binaries
Andrey Talman's avatar
Andrey Talman committed
552
          no_output_timeout: 30m
553
554
555
556
557
558
          command: |
            set -x
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda env remove -n python${PYTHON_VERSION} || true
            conda create -yn python${PYTHON_VERSION} python=${PYTHON_VERSION}
            conda activate python${PYTHON_VERSION}
Andrey Talman's avatar
Andrey Talman committed
559
560
561
            # Include numpy and cudatoolkit in the install conda-forge chanell is used for cudatoolkit
            conda install -v -y -c pytorch-${UPLOAD_CHANNEL} pytorch numpy cudatoolkit=${CU_VERSION:2:2}.${CU_VERSION:4} -c conda-forge
            # Install from torchaudio file
562
563
564
565
566
567
            conda install -v -y $(ls ~/workspace/conda-bld/win-64/torchaudio*.tar.bz2)
      - run:
          name: smoke test
          command: |
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda activate python${PYTHON_VERSION}
Andrey Talman's avatar
Andrey Talman committed
568
569
            # Install sound backend
            pip install PySoundFile
570
            conda install 'ffmpeg<5'
moto's avatar
moto committed
571
            ./test/smoke_test/run_smoke_test.sh
572

573
574
575
576
577
578
579
  smoke_test_windows_pip:
    <<: *binary_common
    executor:
      name: windows-cpu
    steps:
      - attach_workspace:
          at: ~/workspace
580
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
581
      - load_conda_channel_flags
582
583
584
585
586
587
588
589
      - run:
          name: install binaries
          command: |
            set -x
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda env remove -n python${PYTHON_VERSION} || true
            conda create -yn python${PYTHON_VERSION} python=${PYTHON_VERSION}
            conda activate python${PYTHON_VERSION}
590
            pip install $(ls ~/workspace/torchaudio*.whl) -f "https://download.pytorch.org/whl/${UPLOAD_CHANNEL}/torch_${UPLOAD_CHANNEL}.html"
moto's avatar
moto committed
591
      - checkout
592
593
594
595
596
      - run:
          name: smoke test
          command: |
            eval "$('/C/tools/miniconda3/Scripts/conda.exe' 'shell.bash' 'hook')"
            conda activate python${PYTHON_VERSION}
597
598
599
600
601
602
            # Hack to load FFmpeg libraries
            # Note: Depending on Python version, they search different paths.
            # For 3.7 and 3.9, copying them in CWD works.
            cp ~/workspace/ffmpeg/bin/* test/smoke_test/
            # For 3.8 and 3.10, they must be in the same directory as the entrypoint lib
            cp ~/workspace/ffmpeg/bin/* /C/tools/miniconda3/envs/python${PYTHON_VERSION}/lib/site-packages/torchaudio/lib/
moto's avatar
moto committed
603
            ./test/smoke_test/run_smoke_test.sh
604

moto's avatar
moto committed
605
  unittest_linux_cpu:
moto's avatar
moto committed
606
607
    <<: *binary_common
    docker:
608
      - image: pytorch/torchaudio_unittest_base:manylinux-20210121
moto's avatar
moto committed
609
610
611
    resource_class: 2xlarge+
    steps:
      - checkout
612
613
      - attach_workspace:
          at: third_party
614
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
615
      - load_conda_channel_flags
616
617
618
619
620
621
      - run:
          name: Setup
          command: .circleci/unittest/linux/scripts/setup_env.sh
      - run:
          name: Install torchaudio
          command: .circleci/unittest/linux/scripts/install.sh
622
          environment:
623
              BUILD_MAD: true
624
              USE_FFMPEG: true
625
626
627
      - run:
          name: Run tests
          command: .circleci/unittest/linux/scripts/run_test.sh
moto's avatar
moto committed
628
629
          environment:
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUDA: true
630
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310: true
631
632
      - store_test_results:
          path: test-results
633
634
      - store_artifacts:
          path: test/htmlcov
moto's avatar
moto committed
635
636
637
  unittest_linux_gpu:
    <<: *binary_common
    machine:
638
      image: ubuntu-2004-cuda-11.4:202110-01
639
    resource_class: gpu.nvidia.medium
moto's avatar
moto committed
640
    environment:
641
      <<: *environment
moto's avatar
moto committed
642
      image_name: pytorch/torchaudio_unittest_base:manylinux-cuda10.2-cudnn8-20210623
moto's avatar
moto committed
643
644
    steps:
      - checkout
645
646
      - attach_workspace:
          at: third_party
647
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
648
      - load_conda_channel_flags
649
650
651
      - run:
          name: Pull Docker image
          command: docker pull --quiet "${image_name}"
moto's avatar
moto committed
652
653
      - run:
          name: Setup
654
          command: docker run -t --gpus all -e PYTHON_VERSION -v $PWD:$PWD -w $PWD "${image_name}" .circleci/unittest/linux/scripts/setup_env.sh
moto's avatar
moto committed
655
656
      - run:
          name: Install torchaudio
657
          command: docker run -t --gpus all -e UPLOAD_CHANNEL -e CONDA_CHANNEL_FLAGS -e USE_FFMPEG=1 -e BUILD_MAD=1 -v $PWD:$PWD -w $PWD "${image_name}" .circleci/unittest/linux/scripts/install.sh
moto's avatar
moto committed
658
659
      - run:
          name: Run tests
660
661
662
663
          environment:
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310: true
          command: |
            docker run -t --gpus all -v $PWD:$PWD -w $PWD -e "CI=${CI}" -e TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310 "${image_name}" .circleci/unittest/linux/scripts/run_test.sh
moto's avatar
moto committed
664
665
      - store_test_results:
          path: test-results
666
667
      - store_artifacts:
          path: test/htmlcov
moto's avatar
moto committed
668
669

  unittest_windows_cpu:
670
671
672
    <<: *binary_common
    executor:
      name: windows-cpu
673
674
    steps:
      - checkout
675
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
676
      - load_conda_channel_flags
677
678
679
680
681
682
      - run:
          name: Setup
          command: .circleci/unittest/windows/scripts/setup_env.sh
      - run:
          name: Install torchaudio
          command: .circleci/unittest/windows/scripts/install.sh
683
          environment:
684
              USE_FFMPEG: true
685
686
687
      - run:
          name: Run tests
          command: .circleci/unittest/windows/scripts/run_test.sh
moto's avatar
moto committed
688
689
690
691
692
693
694
695
696
697
698
          environment:
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_APPLY_CMVN_SLIDING: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_FBANK_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_KALDI_PITCH_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_MFCC_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_SPECTROGRAM_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_SOX: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CTC_DECODER: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUDA: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_KALDI: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_SOX: true
699
700
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_MOD_sentencepiece: true
701
702
      - store_test_results:
          path: test-results
703
704
      - store_artifacts:
          path: test/htmlcov
705
706
707
708
709
710

  unittest_windows_gpu:
    <<: *binary_common
    executor:
      name: windows-gpu
    environment:
711
      <<: *environment
712
      CUDA_VERSION: "11.3"
713
714
    steps:
      - checkout
715
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
716
      - load_conda_channel_flags
moto's avatar
moto committed
717
718
      - run:
          name: Setup
719
          command: .circleci/unittest/windows/scripts/setup_env.sh
720
721
722
723
724
725
      - run:
          name: Install CUDA
          command: packaging/windows/internal/cuda_install.bat
      - run:
          name: Update CUDA driver
          command: packaging/windows/internal/driver_update.bat
moto's avatar
moto committed
726
      - run:
727
          name: Install torchaudio
728
          command: .circleci/unittest/windows/scripts/install.sh
729
          environment:
730
              USE_FFMPEG: true
moto's avatar
moto committed
731
      - run:
732
          name: Run tests
733
          command: .circleci/unittest/windows/scripts/run_test.sh
moto's avatar
moto committed
734
735
736
737
738
739
740
741
742
743
          environment:
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_APPLY_CMVN_SLIDING: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_FBANK_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_KALDI_PITCH_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_MFCC_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_SPECTROGRAM_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_SOX: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CTC_DECODER: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_KALDI: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_SOX: true
744
745
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_MOD_sentencepiece: true
moto's avatar
moto committed
746
747
      - store_test_results:
          path: test-results
748
749
      - store_artifacts:
          path: test/htmlcov
moto's avatar
moto committed
750

moto's avatar
moto committed
751
752
753
  unittest_macos_cpu:
    <<: *binary_common
    macos:
754
      xcode: "12.0"
moto's avatar
moto committed
755
756
757
    resource_class: large
    steps:
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
758
      - load_conda_channel_flags
moto's avatar
moto committed
759
760
      - attach_workspace:
          at: third_party
761
      - designate_upload_channel
moto's avatar
moto committed
762
763
764
765
766
767
      - run:
          name: Setup
          command: .circleci/unittest/linux/scripts/setup_env.sh
      - run:
          name: Install torchaudio
          command: .circleci/unittest/linux/scripts/install.sh
768
          environment:
769
              USE_FFMPEG: true
770
              BUILD_MAD: true
moto's avatar
moto committed
771
772
773
      - run:
          name: Run tests
          command: .circleci/unittest/linux/scripts/run_test.sh
moto's avatar
moto committed
774
775
776
777
778
779
780
781
          environment:
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_APPLY_CMVN_SLIDING: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_FBANK_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_KALDI_PITCH_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_MFCC_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CMD_COMPUTE_SPECTROGRAM_FEATS: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_CUDA: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_QUANTIZATION: true
782
783
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_ON_PYTHON_310: true
              TORCHAUDIO_TEST_ALLOW_SKIP_IF_NO_MOD_sentencepiece: true
moto's avatar
moto committed
784
785
      - store_test_results:
          path: test-results
786
787
      - store_artifacts:
          path: test/htmlcov
moto's avatar
moto committed
788

789
790
791
792
793
794
795
  stylecheck:
    <<: *binary_common
    docker:
      - image: "pytorch/torchaudio_unittest_base:manylinux"
    resource_class: medium
    steps:
      - checkout
796
      - designate_upload_channel
Eli Uriegas's avatar
Eli Uriegas committed
797
      - load_conda_channel_flags
798
799
800
801
802
803
804
      - run:
          name: Setup
          command: .circleci/unittest/linux/scripts/setup_env.sh
      - run:
          name: Run style check
          command: .circleci/unittest/linux/scripts/run_style_checks.sh

805
806
807
  build_docs:
    <<: *binary_common
    docker:
808
      - image: "python:<< parameters.python_version >>"
809
810
811
812
813
    resource_class: 2xlarge+
    steps:
      - attach_workspace:
          at: ~/workspace
      - checkout
Eli Uriegas's avatar
Eli Uriegas committed
814
      - load_conda_channel_flags
815
      - run:
816
817
818
819
          name: Install packages
          command: |
            apt-get -qq update && apt-get -qq install -y ffmpeg libsndfile-dev
            .circleci/build_docs/install_wheels.sh
820
821
      - run:
          name: Build docs
822
823
824
825
826
          command: |
            cd docs
            make 'SPHINXOPTS=-W' html
          environment:
            BUILD_GALLERY: 1
827
      - persist_to_workspace:
828
          root: ./
829
830
          paths:
            - "*"
831
832
833
      - store_artifacts:
          path: ./docs/build/html
          destination: docs
834
835
836
837
838
839
840
841
842

  upload_docs:
    <<: *binary_common
    docker:
      - image: "pytorch/manylinux-cuda100"
    resource_class: 2xlarge+
    steps:
      - attach_workspace:
          at: ~/workspace
843
844
845
846
847
848
849
850
851
852
      - run:
          name: Generate netrc
          command: |
            # set credentials for https pushing
            # requires the org-member context
            cat > ~/.netrc \<<DONE
              machine github.com
              login pytorchbot
              password ${GITHUB_PYTORCHBOT_TOKEN}
            DONE
853
854
855
      - run:
          name: Upload docs
          command: |
856
857
            # Don't use "checkout" step since it uses ssh, which cannot git push
            # https://circleci.com/docs/2.0/configuration-reference/#checkout
858
            set -ex
859
860
            # turn v1.12.0rc3 into 1.12.0
            tag=$(echo $CIRCLE_TAG | sed -e 's/v*\([0-9.]*\).*/\1/')
861
            target=${tag:-main}
Matti Picus's avatar
Matti Picus committed
862
            ~/workspace/.circleci/build_docs/commit_docs.sh ~/workspace $target
863

864
865
866
  docstring_parameters_sync:
    <<: *binary_common
    docker:
moto's avatar
moto committed
867
      - image: cimg/python:3.8
868
869
870
871
872
873
874
875
    steps:
      - checkout
      - run:
          name: Check parameters docstring sync
          command: |
            pip install --user pydocstyle
            pydocstyle torchaudio

Edward Z. Yang's avatar
Edward Z. Yang committed
876
workflows:
877
878
879
  lint:
    jobs:
      - lint_python_and_config
Edward Z. Yang's avatar
Edward Z. Yang committed
880
881
882
  build:
    jobs:
      - circleci_consistency
moto's avatar
moto committed
883
884
885
886
      {{ build_workflows() }}
  unittest:
    jobs:
      {{ unittest_workflows() }}
Edward Z. Yang's avatar
Edward Z. Yang committed
887
888
  nightly:
    jobs:
moto's avatar
moto committed
889
890
891
892
      - circleci_consistency:
          filters:
            branches:
              only: nightly
moto's avatar
moto committed
893
      {{ build_workflows(prefix="nightly_", filter_branch="nightly", upload=True) }}