From c584a3dfc4f876edb2459084d482bf0a78a7ca8d Mon Sep 17 00:00:00 2001 From: hanhxiao Date: Tue, 13 Aug 2019 20:33:05 +0800 Subject: [PATCH] docs(readme): add image explain to readme --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d38b6e64..79284075 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ GNES enables large-scale index and semantic search for **text-to-text**, **image

Install GNES

-There are two ways to get GNES, either as a Docker image or as a PyPi package. For cloud users, we **highly recommend using GNES via Docker image**. +There are two ways to get GNES, either as a Docker image or as a PyPi package. **For cloud users, we highly recommend using GNES via Docker**. ### Run GNES as a Docker Container @@ -100,31 +100,31 @@ This command downloads the latest GNES image (based on [Alpine Linux](https://al #### Choose the right GNES image -Besides the `alpine` image optimized for the space, we also provide Buster (Debian 10.0) and Ubuntu 18.04-based images. The table below summarizes [all available GNES images and tags](https://cloud.docker.com/u/gnes/repository/docker/gnes/gnes). One can fill in `{ver}` with `latest`, `stable` or `x.x.xx`. `latest` refers to the **latest master** of this repository, which is [mutable and may not always be a stable](./CONTRIBUTING.md#Merging-Process). We recommend you to use an official release by changing the `latest` to a version tag, say `v0.0.24`. Or you may simply use `stable` for the last release. +Besides the `alpine` image optimized for the space, we also provide Buster (Debian 10.0) and Ubuntu 18.04-based images. The table below summarizes [all available GNES tags](https://cloud.docker.com/u/gnes/repository/docker/gnes/gnes). One can fill in `{ver}` with `latest`, `stable` or `v0..xx`. `latest` refers to the **latest master** of this repository, which [may not be stable](./CONTRIBUTING.md#Merging-Process). We recommend you to use an official release by changing the `latest` to a version number, say `v0.0.24`, or simply using `stable` for the last release, e.g. `gnes:ubuntu-stable` - + - + - + - + - +
ImageTag Size and layers Description
gnes:alpine-{ver}alpine-{ver} based on Alpine Linux;
no deep learning libraries;
Extremely lightweight and portable, enables fast scaling on even edge devices.
gnes:buster-{ver}buster-{ver} based on Debian 10.0;
no deep learning libraries;
Recommended for building or extending a GNES-Hub image.
gnes:ubuntu-{ver}ubuntu-{ver} based on Ubuntu 18.04;
no deep learning libraries.
gnes:full-{ver}full-{ver} based on Ubuntu 16.04;
python-3.6.8, cuda-10.0, tf1.14, pytorch1.1, faiss, multiple pretrained models;
Heavy but self-contained, useful in testing GNES end-to-endly.