Skip to content
This repository has been archived by the owner on Feb 22, 2020. It is now read-only.

Commit

Permalink
Merge pull request #137 from gnes-ai/add-hub-readme-2
Browse files Browse the repository at this point in the history
docs: link gnes hub tutorial to readme
  • Loading branch information
mergify[bot] authored Aug 22, 2019
2 parents 1a284b8 + a2801d5 commit 2344a6a
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Dockerfiles/alpine.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ RUN apk add --no-cache \
musl-dev python3-dev py-pgen cython openblas-dev && \
apk add --no-cache libstdc++ openblas libzmq && \
ln -s locale.h /usr/include/xlocale.h && \
pip install .[http] --no-cache-dir --compile && \
pip install . --no-cache-dir --compile && \
find /usr/lib/python3.7/ -name 'tests' -exec rm -r '{}' + && \
find /usr/lib/python3.7/site-packages/ -name '*.so' -print -exec sh -c 'file "{}" | grep -q "not stripped" && strip -s "{}"' \; && \
rm /usr/include/xlocale.h && \
Expand Down
2 changes: 1 addition & 1 deletion Dockerfiles/buster.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ RUN apt-get update && apt-get install --no-install-recommends -y \
build-essential \
python3-dev libopenblas-dev && \
ln -s locale.h /usr/include/xlocale.h && \
pip install .[http] --no-cache-dir --compile && \
pip install . --no-cache-dir --compile && \
rm -rf /tmp/* && rm -rf /gnes && \
apt-get autoremove && apt-get clean && rm -rf /var/lib/apt/lists/* && \
rm /usr/include/xlocale.h
Expand Down
2 changes: 1 addition & 1 deletion Dockerfiles/ubuntu18.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ RUN apt-get update && apt-get install --no-install-recommends -y \
build-essential python3-dev python3-pip python3-setuptools libopenblas-dev && \
export LC_ALL=en_US.UTF-8 && export LANG=en_US.UTF-8 && export LC_CTYPE=en_US.UTF-8 && \
ln -s /usr/bin/python3 python && \
pip3 install .[http] --no-cache-dir --compile && \
pip3 install . --no-cache-dir --compile && \
rm -rf /tmp/* && rm -rf /gnes && \
apt-get autoremove && apt-get clean && rm -rf /var/lib/apt/lists/*

Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<a href="#overview">Overview</a> •
<a href="#install-gnes">Install</a> •
<a href="#getting-started">Getting Started</a> •
<a href="https://github.com/gnes-ai/hub">GNES Hub</a> •
<a href="https://github.com/gnes-ai/hub">Hub</a> •
<a href="#documentation">Documentation</a> •
<a href="#tutorial">Tutorial</a> •
<a href="#contributing">Contributing</a> •
Expand Down Expand Up @@ -177,7 +177,7 @@ Note that this will only install a "barebone" version of GNES, consists of **the

> 🚸 Tensorflow, Pytorch and torchvision are not part of GNES installation. Depending on your model, you may have to install them in advance.
Though not recommended, you may install GNES with full dependencies via:
Though not recommended, you can install GNES with full dependencies via:
```bash
pip install gnes[all]
```
Expand All @@ -204,6 +204,8 @@ pip install gnes[all]
</table>
</details>

A good way to cherry-pick dependencies is following [the example in GNES Hub](https://github.com/gnes-ai/hub#cherry-picking-dependencies-to-enable-gnes-built-in-models) and building you own GNES image.

Either way, if you end up reading the following message after `$ gnes` or `$ docker run gnes/gnes`, then you are ready to go!

<p align="center">
Expand Down Expand Up @@ -605,14 +607,18 @@ The official documentation of GNES is hosted on [doc.gnes.ai](https://doc.gnes.a

- [How to write your GNES YAML config](tutorials/gnes-compose-yaml-spec.md)
- [How to write a component-wise YAML config](tutorials/component-yaml-spec.md)
- Understanding preprocessor, encoder, indexer and router
- [Model management with GNES Hub](https://github.com/gnes-ai/hub#tutorial)
* [Porting `PyTorch-Transformers` into GNES](https://github.com/gnes-ai/hub#porting-pytorch-transformers-into-gnes)
* [Porting multiple modules in a row](https://github.com/gnes-ai/hub#porting-multiple-modules-in-a-row)
* [Cherry-picking dependencies and build your own GNES](https://github.com/gnes-ai/hub#cherry-picking-dependencies-to-enable-gnes-built-in-models)
- [Understanding preprocessor, encoder, indexer and router](https://hanxiao.github.io/2019/07/29/Generic-Neural-Elastic-Search-From-bert-as-service-and-Go-Way-Beyond/#gnes-preliminaries-breakdown-of-neural-elastic-and-search)
- Index and query text data with GNES
- Index and query image data with GNES
- Index and query video data with GNES
- Using GNES with Kubernetes
- Using GNES in other language (besides Python)
- Serves HTTP-request with GNES in an end-to-end way
- Model-as-plugin: write your own component

- Migrating from [`bert-as-service`](https://github.com/hanxiao/bert-as-service)

<h2 align="center">Contributing</h2>
Expand Down

0 comments on commit 2344a6a

Please sign in to comment.