From 1d674783b0eaa18cede86f4020388a824d233427 Mon Sep 17 00:00:00 2001 From: Evan Lezar Date: Wed, 22 Sep 2021 15:22:53 +0200 Subject: [PATCH] Copy README.md from nvidia-docker Signed-off-by: Evan Lezar --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..68f0734a --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# NVIDIA Container Toolkit + +[![GitHub license](https://img.shields.io/github/license/NVIDIA/nvidia-docker?style=flat-square)](https://raw.githubusercontent.com/NVIDIA/nvidia-docker/master/LICENSE) +[![Documentation](https://img.shields.io/badge/documentation-wiki-blue.svg?style=flat-square)](https://github.com/NVIDIA/nvidia-docker/wiki) +[![Package repository](https://img.shields.io/badge/packages-repository-b956e8.svg?style=flat-square)](https://nvidia.github.io/nvidia-docker) + +![nvidia-gpu-docker](https://cloud.githubusercontent.com/assets/3028125/12213714/5b208976-b632-11e5-8406-38d379ec46aa.png) + +## Introduction +The NVIDIA Container Toolkit allows users to build and run GPU accelerated Docker containers. The toolkit includes a container runtime [library](https://github.com/NVIDIA/libnvidia-container) and utilities to automatically configure containers to leverage NVIDIA GPUs. + +Product documentation including an architecture overview, platform support, installation and usage guides can be found in the [documentation repository](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/overview.html). + +Frequently asked questions are available on the [wiki](https://github.com/NVIDIA/nvidia-docker/wiki). + +## Getting Started + +**Make sure you have installed the [NVIDIA driver](https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#how-do-i-install-the-nvidia-driver) and Docker engine for your Linux distribution** +**Note that you do not need to install the CUDA Toolkit on the host system, but the NVIDIA driver needs to be installed** + +For instructions on getting started with the NVIDIA Container Toolkit, refer to the [installation guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker). + +## Usage + +The [user guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/user-guide.html) provides information on the configuration and command line options available when running GPU containers with Docker. + +## Issues and Contributing + +[Checkout the Contributing document!](CONTRIBUTING.md) + +* Please let us know by [filing a new issue](https://github.com/NVIDIA/nvidia-docker/issues/new) +* You can contribute by opening a [pull request](https://help.github.com/articles/using-pull-requests/) \ No newline at end of file