From cee02b077adf2e8cf63a7a19d3382fb21e54191f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Ho=CC=88nicke?= Date: Tue, 18 Apr 2023 17:47:11 +0200 Subject: [PATCH] docs: fix documentation --- README.md | 124 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 89 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 569b83c..6c2f4f6 100644 --- a/README.md +++ b/README.md @@ -97,75 +97,117 @@ jc delete ## Examples - -QR Code Generator - +In this section you can get a feeling for the kind of microservices that can be generated with GPT Deploy. ### Chemical Formula Visualization ```bash -generate --description "Convert a chemical formula into a 2D chemical structure diagram" --test "C=C, CN=C=O, CCC(=O)O" --path microservice +generate \ +--description "Convert a chemical formula into a 2D chemical structure diagram" \ +--test "C=C, CN=C=O, CCC(=O)O" \ +--model gpt-4 \ +--path microservice ``` -Chemical Formula Visualization +Chemical Formula Visualization + +### 2d rendering of 3d model +```bash +gptdeploy generate \ +--description "create a 2d rendering of a whole 3d object and x,y,z object rotation using trimesh and pyrender.OffscreenRenderer with os.environ['PYOPENGL_PLATFORM'] = 'egl' and freeglut3-dev library" \ +--test "input: https://graphics.stanford.edu/courses/cs148-10-summer/as3/code/as3/teapot.obj output: assert the image is not completely white or black" \ +--model gpt-4 \ +--path microservice +``` +2D Rendering of 3D Model ## Hacker News Search ```bash -generate --description "Given a search query, find articles on hacker news using the hacker news api and return a list of (title, author, website_link, first_image_on_the_website)" --test "searching for GPT gives results" --path microservice +generate \ +--description "Given a search query, find articles on hacker news using the hacker news api and return a list of (title, author, website_link, first_image_on_the_website)" \ +--test "searching for GPT gives results" \ +--model gpt-4 \ +--path microservice ```` -Hacker News Search +Hacker News Search ### Animal Detector ```bash -gptdeploy generate --description "Given an image, return the image with bounding boxes of all animals (https://pjreddie.com/media/files/yolov3.weights, https://raw.githubusercontent.com/pjreddie/darknet/master/cfg/yolov3.cfg)" --test "https://images.unsplash.com/photo-1444212477490-ca407925329e contains animals" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Given an image, return the image with bounding boxes of all animals (https://pjreddie.com/media/files/yolov3.weights, https://raw.githubusercontent.com/pjreddie/darknet/master/cfg/yolov3.cfg)" \ +--test "https://images.unsplash.com/photo-1444212477490-ca407925329e contains animals" \ +--model gpt-4 \ +--path microservice ``` -Animal Detector +Animal Detector ### Meme Generator ```bash -gptdeploy generate --description "Generate a meme from an image and a caption" --test "Surprised Pikachu: https://media.wired.com/photos/5f87340d114b38fa1f8339f9/master/w_1600%2Cc_limit/Ideas_Surprised_Pikachu_HD.jpg, TOP:When you discovered GPTDeploy" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Generate a meme from an image and a caption" \ +--test "Surprised Pikachu: https://media.wired.com/photos/5f87340d114b38fa1f8339f9/master/w_1600%2Cc_limit/Ideas_Surprised_Pikachu_HD.jpg, TOP:When you discovered GPTDeploy" \ +--model gpt-4 \ +--path microservice ``` -Meme Generator +Meme Generator ### Rhyme Generator ```bash -gptdeploy generate --description "Given a word, return a list of rhyming words using the datamuse api" --test "hello" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Given a word, return a list of rhyming words using the datamuse api" \ +--test "hello" \ +--model gpt-4 \ +--path microservice ``` -Rhyme Generator +Rhyme Generator ### Word Cloud Generator ```bash -gptdeploy generate --description "Generate a word cloud from a given text" --test "Lorem ipsum dolor sit amet, consectetur adipiscing elit." --model gpt-4 --path microservice +gptdeploy generate \ +--description "Generate a word cloud from a given text" \ +--test "Lorem ipsum dolor sit amet, consectetur adipiscing elit." \ +--model gpt-4 \ +--path microservice ``` -Word Cloud Generator +Word Cloud Generator ### 3d model info ```bash -gptdeploy generate --description "Given a 3d object, return vertex count and face count" --test "https://raw.githubusercontent.com/polygonjs/polygonjs-assets/master/models/wolf.obj" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Given a 3d object, return vertex count and face count" \ +--test "https://raw.githubusercontent.com/polygonjs/polygonjs-assets/master/models/wolf.obj" \ +--model gpt-4 \ +--path microservice ``` -3D Model Info - -### 2d rendering of 3d model -```bash -gptdeploy generate --description "create a 2d rendering of a whole 3d object and x,y,z object rotation using trimesh and pyrender.OffscreenRenderer with os.environ['PYOPENGL_PLATFORM'] = 'egl' and freeglut3-dev library" --test "input: https://graphics.stanford.edu/courses/cs148-10-summer/as3/code/as3/teapot.obj output: assert the image is not completely white or black" --model gpt-4 --path microservice -``` -2D Rendering of 3D Model +3D Model Info ### Table extraction ```bash -gptdeploy generate --description "Given a URL, extract all tables as csv" --test "http://www.ins.tn/statistiques/90" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Given a URL, extract all tables as csv" \ +--test "http://www.ins.tn/statistiques/90" \ +--model gpt-4 \ +--path microservice ``` -Table Extraction +Table Extraction ### Audio to mel spectrogram ```bash -gptdeploy generate --description "Create mel spectrograms from audio file" --test "https://cdn.pixabay.com/download/audio/2023/02/28/audio_550d815fa5.mp3" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Create mel spectrograms from audio file" \ +--test "https://cdn.pixabay.com/download/audio/2023/02/28/audio_550d815fa5.mp3" \ +--model gpt-4 \ +--path microservice ``` -Audio to Mel Spectrogram +Audio to Mel Spectrogram ### Text to speech ```bash -gptdeploy generate --description "Convert text to speech" --test "Hello, welcome to GPT Deploy!" --model gpt-4 --path microservice +gptdeploy generate \ +--description "Convert text to speech" \ +--test "Hello, welcome to GPT Deploy!" \ +--model gpt-4 \ +--path microservice ``` -Text to Speech +Text to Speech