├── renovate.json ├── src ├── dvc │ ├── devcontainer-feature.json │ ├── install.sh │ └── README.md └── nvtop │ ├── devcontainer-feature.json │ ├── install.sh │ └── README.md ├── .devcontainer.json ├── test ├── nvtop │ └── test.sh └── dvc │ └── test.sh ├── .github └── workflows │ ├── test.yaml │ └── release.yaml ├── README.md └── LICENSE /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:base" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /src/dvc/devcontainer-feature.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Data Version Control", 3 | "id": "dvc", 4 | "version": "1.0.4", 5 | "description": "Installs DVC CLI deb package", 6 | "options": {} 7 | } 8 | -------------------------------------------------------------------------------- /src/nvtop/devcontainer-feature.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "nvtop - GPUs Process monitoring", 3 | "id": "nvtop", 4 | "version": "1.0.0", 5 | "description": "Installs nvtop utility", 6 | "options": {} 7 | } 8 | -------------------------------------------------------------------------------- /src/dvc/install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -ue 3 | 4 | echo "Activating feature 'dvc'" 5 | 6 | export DEBIAN_FRONTEND=noninteractive 7 | 8 | cd /etc/apt/sources.list.d 9 | wget https://dvc.org/deb/dvc.list 10 | apt-get update 11 | apt-get install --yes dvc 12 | apt-get clean 13 | rm --recursive --force /var/lib/apt/lists/* 14 | -------------------------------------------------------------------------------- /.devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "image": "mcr.microsoft.com/vscode/devcontainers/javascript-node:0-18", 3 | "customizations": { 4 | "vscode": { 5 | "extensions": [ 6 | "mads-hartmann.bash-ide-vscode" 7 | ] 8 | } 9 | }, 10 | "features": { 11 | "ghcr.io/devcontainers/features/docker-in-docker:1": {} 12 | }, 13 | "postCreateCommand": "npm install -g @devcontainers/cli" 14 | } -------------------------------------------------------------------------------- /src/nvtop/install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -ue 3 | 4 | echo "Activating feature 'nvtop'" 5 | 6 | export DEBIAN_FRONTEND=noninteractive 7 | 8 | apt-get update --yes 9 | apt-get install --yes libdrm-dev libsystemd-dev 10 | apt-get install --yes cmake libncurses5-dev libncursesw5-dev git 11 | apt-get install --yes build-essential 12 | git clone https://github.com/Syllo/nvtop.git 13 | mkdir -p nvtop/build && cd nvtop/build 14 | cmake .. -DNVIDIA_SUPPORT=ON -DAMDGPU_SUPPORT=ON -DINTEL_SUPPORT=ON 15 | make 16 | make install 17 | -------------------------------------------------------------------------------- /src/dvc/README.md: -------------------------------------------------------------------------------- 1 | 2 | # Data Version Control (dvc) 3 | 4 | Installs DVC CLI deb package 5 | 6 | ## Example Usage 7 | 8 | ```json 9 | "features": { 10 | "ghcr.io/iterative/features/dvc:1": {} 11 | } 12 | ``` 13 | 14 | ## Options 15 | 16 | | Options Id | Description | Type | Default Value | 17 | |-----|-----|-----|-----| 18 | 19 | 20 | 21 | 22 | --- 23 | 24 | _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/iterative/features/blob/main/src/dvc/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ 25 | -------------------------------------------------------------------------------- /src/nvtop/README.md: -------------------------------------------------------------------------------- 1 | 2 | # nvtop - GPUs Process monitoring (nvtop) 3 | 4 | Installs nvtop utility 5 | 6 | ## Example Usage 7 | 8 | ```json 9 | "features": { 10 | "ghcr.io/iterative/features/nvtop:1": {} 11 | } 12 | ``` 13 | 14 | ## Options 15 | 16 | | Options Id | Description | Type | Default Value | 17 | |-----|-----|-----|-----| 18 | 19 | 20 | 21 | 22 | --- 23 | 24 | _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/iterative/features/blob/main/src/nvtop/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ 25 | -------------------------------------------------------------------------------- /test/nvtop/test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This test file will be executed against an auto-generated devcontainer.json 4 | # that includes the 'nvtop' feature with no options. 5 | # 6 | # Eg: 7 | # { 8 | # "image": "<..some-base-image...>", 9 | # "features": { 10 | # "nvtop": {} 11 | # } 12 | # } 13 | # 14 | # This test can be run with the following command (from the root of this repo) 15 | # devcontainer features test \ 16 | # --features nvtop \ 17 | # --base-image mcr.microsoft.com/devcontainers/base:ubuntu . 18 | 19 | set -e 20 | 21 | # Optional: Import test library bundled with the devcontainer CLI 22 | source dev-container-features-test-lib 23 | 24 | check "version" nvtop --version 25 | 26 | # Report result 27 | reportResults 28 | -------------------------------------------------------------------------------- /test/dvc/test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This test file will be executed against an auto-generated devcontainer.json 4 | # that includes the 'dvc' feature with no options. 5 | # 6 | # Eg: 7 | # { 8 | # "image": "<..some-base-image...>", 9 | # "features": { 10 | # "dvc": {} 11 | # } 12 | # } 13 | # 14 | # This test can be run with the following command (from the root of this repo) 15 | # devcontainer features test \ 16 | # --features dvc \ 17 | # --base-image mcr.microsoft.com/devcontainers/base:ubuntu . 18 | 19 | set -e 20 | 21 | # Optional: Import test library bundled with the devcontainer CLI 22 | source dev-container-features-test-lib 23 | 24 | LATEST_VERSION=$(wget -O - dvc.org/deb/dists/stable/main/binary-amd64/Packages | 25 | grep "Version:" | cut -d " " -f 2 | tail -1) 26 | INSTALLED_VERSION=$(dvc version | grep "DVC version" | cut -d " " -f 3) 27 | 28 | check "version" test "$LATEST_VERSION"x = "$INSTALLED_VERSION"x 29 | 30 | # Report result 31 | # If any of the checks above exited with a non-zero exit code, the test will 32 | # fail. 33 | reportResults 34 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: "CI - Test Features" 2 | on: 3 | push: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | test: 8 | runs-on: ubuntu-latest 9 | continue-on-error: true 10 | strategy: 11 | matrix: 12 | features: [ 13 | "dvc", 14 | "nvtop", 15 | ] 16 | baseImage: 17 | [ 18 | "mcr.microsoft.com/devcontainers/base:ubuntu" 19 | ] 20 | steps: 21 | - uses: actions/checkout@v4 22 | 23 | - name: "Install latest devcontainer CLI" 24 | run: npm install -g @devcontainers/cli 25 | 26 | - name: "Generating tests for '${{ matrix.features }}' against '${{ matrix.baseImage }}'" 27 | run: devcontainer features test -f ${{ matrix.features }} -i ${{ matrix.baseImage }} . 28 | 29 | test-global: 30 | runs-on: ubuntu-latest 31 | continue-on-error: true 32 | steps: 33 | - uses: actions/checkout@v4 34 | 35 | - name: "Install latest devcontainer CLI" 36 | run: npm install -g @devcontainers/cli 37 | 38 | - name: "Testing global scenarios" 39 | run: devcontainer features test --global-scenarios-only . 40 | -------------------------------------------------------------------------------- /.github/workflows/release.yaml: -------------------------------------------------------------------------------- 1 | name: "Release dev container features & Generate Documentation" 2 | on: 3 | workflow_dispatch: 4 | 5 | jobs: 6 | deploy: 7 | if: ${{ github.ref == 'refs/heads/main' }} 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v4 11 | 12 | - name: "Publish Features" 13 | uses: devcontainers/action@v1 14 | with: 15 | publish-features: "true" 16 | base-path-to-features: "./src" 17 | generate-docs: "true" 18 | 19 | env: 20 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 21 | 22 | - uses: iterative/setup-cml@v1 23 | 24 | - name: Create PR for Documentation 25 | id: push_image_info 26 | env: 27 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 28 | run: | 29 | cml pr create */**/README.md \ 30 | --user-name=github-actions[bot] \ 31 | --user-email=41898282+github-actions[bot]@users.noreply.github.com \ 32 | --branch="automated-documentation-update-$GITHUB_RUN_ID" \ 33 | --{title,message,body}="Automated documentation update" \ 34 | --skip-ci 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Container Features for Machine Learning 2 | 3 | A set of simple and reusable 4 | [development container 'features'](https://github.com/devcontainers/features) 5 | for Machine Learning and Data Science. 6 | E.g. to quickly add [DVC](https://dvc.org) to a development container, 7 | install [nvtop](https://github.com/Syllo/nvtop) for GPUs monitoring, etc. 8 | 9 | 10 | ## Usage 11 | 12 | To reference a feature from this repository, add the desired features to a 13 | `devcontainer.json`. Each feature has a `README.md` that shows how to reference 14 | the feature and which options are available for that feature. 15 | 16 | See the relevant feature's README for supported options. 17 | 18 | ```jsonc 19 | "name": "example-get-started", 20 | "image": "mcr.microsoft.com/devcontainers/base:ubuntu", // Any generic, debian-based image. 21 | "features": { 22 | "ghcr.io/iterative/features/dvc:1": {}, 23 | "ghcr.io/iterative/features/nvtop:1": {} 24 | } 25 | ``` 26 | 27 | Read more how to use development container features 28 | [here](https://github.com/devcontainers/features). 29 | 30 | 31 | ## Contributing 32 | 33 | This repository will accept improvement, bug fix, and new features 34 | contributions. 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2017-2021 Iterative, Inc. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------