Merge pull request #5 from linto-ai/next

rename linto-platform-punctuation -> linto-punctuation

Author: Jeronymous

.github/workflows/dockerhub-description.yml

@@ -16,5 +16,5 @@ jobs:
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_PASSWORD }}
-        repository: lintoai/linto-platform-punctuation
+        repository: lintoai/linto-punctuation
         readme-filepath: ./README.md

Jenkinsfile

@@ -1,7 +1,7 @@
 pipeline {
     agent any
     environment {
-        DOCKER_HUB_REPO = "lintoai/linto-platform-punctuation"
+        DOCKER_HUB_REPO = "lintoai/linto-punctuation"
         DOCKER_HUB_CRED = 'docker-hub-credentials'
 
         VERSION = ''

README.md

@@ -1,7 +1,7 @@
-# LINTO-PLATFORM-PUNCTUATION
-LinTO-platform-punctuation is a LinTO service for punctuation prediction. It predicts punctuation from raw text or raw transcription.
+# LINTO-PUNCTUATION
+LinTO-Punctuation is a LinTO service for punctuation prediction. It predicts punctuation from raw text or raw transcription.
 
-LinTO-platform-punctuation can either be used as a standalone punctuation service or deployed as a micro-service.
+LinTO-Punctuation can either be used as a standalone punctuation service or deployed as a micro-service.
 
 ## Table of content
 * [Prerequisites](#pre-requisites)
@@ -47,21 +47,21 @@ For GPU capabilities, it is also needed to install
 The punctuation only entry point in job mode are tasks posted on a REDIS message broker using [Celery](https://github.com/celery/celery). 
 
 ## Deploy
-linto-platform-punctuation can be deployed two different ways:
+linto-punctuation can be deployed two different ways:
 * As a standalone punctuation service through an HTTP API.
 * As a micro-service connected to a task queue.
 
 **1- First step is to build the image:**
 
 ```bash
-git clone https://github.com/linto-ai/linto-platform-punctuation.git
-cd linto-platform-punctuation
-docker build . -t linto-platform-punctuation:latest
+git clone https://github.com/linto-ai/linto-punctuation.git
+cd linto-punctuation
+docker build . -t linto-punctuation:latest
 ```
 
 or 
 ```bash
-docker pull registry.linto.ai/lintoai/linto-platform-punctuation:latest
+docker pull registry.linto.ai/lintoai/linto-punctuation:latest
 ```
 
 **2- Download the models**
@@ -90,7 +90,7 @@ docker run --rm \
 -v <MODEL_PATH>:/usr/src/app/model-store/model \
 -p HOST_SERVING_PORT:80 \
 --env-file .env \
-linto-platform-punctuation:latest
+linto-punctuation:latest
 ```
 
 Also add ```--gpus all``` as an option to enable GPU capabilities.
@@ -99,8 +99,8 @@ This will run a container providing an http API binded on the host HOST_SERVING_
 
 
 ### Micro-service
->LinTO-platform-punctuation can be deployed as a microservice. Used this way, the container spawn celery workers waiting for punctuation tasks on a dedicated task queue.
->LinTO-platform-punctuation in task mode requires a configured REDIS broker.
+>LinTO-Punctuation can be deployed as a microservice. Used this way, the container spawn celery workers waiting for punctuation tasks on a dedicated task queue.
+>LinTO-Punctuation in task mode requires a configured REDIS broker.
 
 You need a message broker up and running at MY_SERVICE_BROKER. Instance are typically deployed as services in a docker swarm using the docker compose command:
 
@@ -132,7 +132,7 @@ version: '3.7'
 
 services:
   punctuation-service:
-    image: linto-platform-punctuation:latest
+    image: linto-punctuation:latest
     volumes:
       - /my/path/to/models/punctuation.mar:/usr/src/app/model-store/model
     env_file: .env

docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.7'
 
 services:
   punctuation-service:
-    image: linto-platform-punctuation:latest
+    image: linto-punctuation:latest
     volumes:
       - /path/to/your/model.mar/usr/src/app/model-store/model
     env_file: .env

document/swagger.yml

@@ -2,7 +2,7 @@ swagger: "2.0"
 
 info:
   version: "1.0.0"
-  title: LinTo-Platform-Punctuation
+  title: LinTO-Punctuation
   description: Punctuation API
   contact:
     email: "[email protected]"

http_server/swagger.py

@@ -11,7 +11,7 @@ def setupSwaggerUI(app, args):
         args.swagger_prefix + args.swagger_url,
         args.swagger_path,
         config={  # Swagger UI config overrides
-            "app_name": "LinTO Platform Punctuation",
+            "app_name": "LinTO Punctuation",
             "spec": swagger_yml,
         },
     )