From 3a7592273baa6d3124a15fa01570bce268450475 Mon Sep 17 00:00:00 2001 From: Dani El-Ayyass Date: Sun, 13 Jun 2021 17:21:18 +0300 Subject: [PATCH] release v1.0.0 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3e4035e..4d203e4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ### What is MUSE? -**MUSE** stands for **Multilingual Universal Sentence Encoder** - multilingual extension (16 languages) of **Universal Sentence Encoder** (USE).
+**MUSE** stands for **Multilingual Universal Sentence Encoder** - multilingual extension (16 languages) of **Universal Sentence Encoder** (**USE**).
**MUSE/USE** models encode sentences into embedding vectors of fixed size. **MUSE** paper: [link](https://arxiv.org/abs/1907.04307).
@@ -7,9 +7,9 @@ **USE** Visually Explainer article: [link](https://amitness.com/2020/06/universal-sentence-encoder/).
### What is MUSE as Service? -**MUSE as Service"** is REST API for sentence tokenization and embedding using **MUSE**.
+**MUSE as Service"** is REST API for sentence tokenization and embedding using MUSE.
It is written on **flask + gunicorn**.
-You can configure **gunicorn** with [**gunicorn.conf.py**](gunicorn.conf.py) file. +You can configure **gunicorn** with [gunicorn.conf.py](gunicorn.conf.py) file. ### Installation ``` @@ -22,7 +22,7 @@ pip install -r requirements.txt ``` ### Run Service -To launch a service use a docker container (either locally or on a server): +To launch a service use a **docker container** (either locally or on a server): ``` docker build -t muse_as_service . docker run -d -p 5000:5000 --name muse_as_service muse_as_service @@ -31,7 +31,7 @@ docker run -d -p 5000:5000 --name muse_as_service muse_as_service **NOTE**: instead of building a docker image, you can pull it from [Docker Hub](https://hub.docker.com/r/dayyass/muse_as_service): `docker pull dayyass/muse_as_service`
### Usage -After you launch the service, you can tokenize and embed any {*sentence*} using GET requests ({*ip*} is the address where the service was launched): +After you launch the service, you can tokenize and embed any {*sentence*} using **GET requests** ({*ip*} is the address where the service was launched): ``` http://{ip}:5000/tokenize?sentence={sentence} http://{ip}:5000/embed?sentence={sentence}