diff --git a/examples/docker/ocr-solara/README.md b/examples/docker/ocr-solara/README.md new file mode 100644 index 00000000..e8755805 --- /dev/null +++ b/examples/docker/ocr-solara/README.md @@ -0,0 +1,3 @@ +# OCR app + +A Solara app to extract text from images. \ No newline at end of file diff --git a/examples/docker/personality-quiz-rag-solara/README.md b/examples/docker/personality-quiz-rag-solara/README.md index 9cbd1d71..b8f00b13 100644 --- a/examples/docker/personality-quiz-rag-solara/README.md +++ b/examples/docker/personality-quiz-rag-solara/README.md @@ -1,3 +1,7 @@ +# Personality Quiz + +A RAG application to deduce user's Myers-Briggs personality type from answers to quiz questions. + ## How to run this application locally ### 1. Install dependencies diff --git a/examples/docker/shiny-express/README.md b/examples/docker/shiny-express/README.md new file mode 100644 index 00000000..e4b92c91 --- /dev/null +++ b/examples/docker/shiny-express/README.md @@ -0,0 +1,3 @@ +# Restaurant tipping dashboard + +A restaurant tipping dashboard designed to offer valuable insights into tipping behaviors like average tip, tips percentage over the week, etc. \ No newline at end of file diff --git a/examples/docker/shiny/README.md b/examples/docker/shiny/README.md index ad497cc6..9f8c9dde 100644 --- a/examples/docker/shiny/README.md +++ b/examples/docker/shiny/README.md @@ -1,6 +1,8 @@ # Model monitoring application -This app is built on Shiny and allows you to visualize model training accuracy scores in realtime in 2 steps: +A Shiny app to visualize model training accuracy scores in realtime. + +## Steps * Train multiple models with different parameters locally, and store the accuracy scores to a remote database at the end of every epoch. * The visualisation application dynamically detects changes in the remote database and generates a plot as the training progresses. diff --git a/examples/docker/solara/README.md b/examples/docker/solara/README.md index 1116eb3f..a89179b1 100644 --- a/examples/docker/solara/README.md +++ b/examples/docker/solara/README.md @@ -1,6 +1,8 @@ # Keyword Extraction Solara App -This Solara app is designed for performing keyword extraction from text documents. Currently, it supports the packages `PyTextRank` and `Yake` for extracting the most relevant keywords from the input text. +A Solara app designed for performing keyword extraction from text documents. + +Currently, it supports the packages `PyTextRank` and `Yake` for extracting the most relevant keywords from the input text. The extracted keywords can be useful for content analysis, search engine optimization (SEO), and other natural language processing tasks. ## Getting Started diff --git a/examples/docker/streamlit/README.md b/examples/docker/streamlit/README.md new file mode 100644 index 00000000..377c6517 --- /dev/null +++ b/examples/docker/streamlit/README.md @@ -0,0 +1,3 @@ +# A basic app + +A basic Streamlit app. \ No newline at end of file diff --git a/examples/docker/video-rag/README.md b/examples/docker/video-rag/README.md index ac56c828..37653ce7 100644 --- a/examples/docker/video-rag/README.md +++ b/examples/docker/video-rag/README.md @@ -1,5 +1,7 @@ ## RAG from video +A RAG application that takes video content as input and answers questions about it. + This is a full stack project that uses a video as input, populates an ElasticSearch instance with vectors through an indexing pipeline, and initializes a retriver pipeline with a Solara app. A complete walk through of this application can be found [here](https://ploomber.io/blog/rag-video-app/) diff --git a/examples/docker/voila/README.md b/examples/docker/voila/README.md index 615cade7..3d213768 100644 --- a/examples/docker/voila/README.md +++ b/examples/docker/voila/README.md @@ -1,3 +1,5 @@ -# Custom Voila app +# Scotch data visualisation + +A dashboard for visualising different properties of the type of scotch selected by the user. `app.ipynb` was taken from the [`voila-gridstack`](https://github.com/voila-dashboards/voila-gridstack/blob/main/examples/scotch_dashboard.ipynb) repository. \ No newline at end of file diff --git a/examples/panel/chat-with-github/README.md b/examples/panel/chat-with-github/README.md index 3c49742d..390358a2 100644 --- a/examples/panel/chat-with-github/README.md +++ b/examples/panel/chat-with-github/README.md @@ -1,6 +1,6 @@ # Chat with Github -This Panel app enables users to chat with their GitHub repositories using the llama_index [GithubRepositoryReader](https://docs.llamaindex.ai/en/stable/examples/data_connectors/GithubRepositoryReaderDemo.html). +A Panel app that enables users to chat with their GitHub repositories using the llama_index [GithubRepositoryReader](https://docs.llamaindex.ai/en/stable/examples/data_connectors/GithubRepositoryReaderDemo.html). To run the app you need to set a couple of [environment variables](https://docs.cloud.ploomber.io/en/latest/user-guide/env-vars.html): diff --git a/examples/panel/chat-with-pdf/README.md b/examples/panel/chat-with-pdf/README.md index 29c51d45..f919b595 100644 --- a/examples/panel/chat-with-pdf/README.md +++ b/examples/panel/chat-with-pdf/README.md @@ -1,6 +1,8 @@ # Chat with a PDF -This Panel app was [originally developed](https://github.com/holoviz-topics/panel-chat-examples/blob/main/docs/examples/langchain/langchain_pdf_assistant.py) by [Andrew Huang](https://github.com/ahuang11), +A Panel app that allows users to chat with a PDF document. + +This app was [originally developed](https://github.com/holoviz-topics/panel-chat-examples/blob/main/docs/examples/langchain/langchain_pdf_assistant.py) by [Andrew Huang](https://github.com/ahuang11), and [Marc Skov Madsen](https://github.com/MarcSkovMadsen). [Click here](https://docs.cloud.ploomber.io/en/latest/apps/panel.html) to see deployment instructions. \ No newline at end of file diff --git a/examples/panel/data-viz/README.md b/examples/panel/data-viz/README.md new file mode 100644 index 00000000..d21618b5 --- /dev/null +++ b/examples/panel/data-viz/README.md @@ -0,0 +1,3 @@ +# Penguin Crossfilter + +A Panel app that uses the box-select and lasso-select tools to select a subset of penguins and reveal more information about the selected subgroup through the power of cross-filtering. \ No newline at end of file diff --git a/examples/panel/rag-news/README.md b/examples/panel/rag-news/README.md index 6c6ec716..78cdc861 100644 --- a/examples/panel/rag-news/README.md +++ b/examples/panel/rag-news/README.md @@ -1,5 +1,7 @@ # News summarizer +A RAG application for summarizing the latest news. + To download today's news and compute the embeddings you first need to set the OpenAI key: ```bash diff --git a/examples/shiny-r/shiny-r-data-visualization/README.md b/examples/shiny-r/shiny-r-data-visualization/README.md new file mode 100644 index 00000000..5d1277d3 --- /dev/null +++ b/examples/shiny-r/shiny-r-data-visualization/README.md @@ -0,0 +1,3 @@ +# Data visualization + +An app for visualising the Penguins dataset. \ No newline at end of file diff --git a/examples/shiny/basic-app/README.md b/examples/shiny/basic-app/README.md index ad497cc6..9f8c9dde 100644 --- a/examples/shiny/basic-app/README.md +++ b/examples/shiny/basic-app/README.md @@ -1,6 +1,8 @@ # Model monitoring application -This app is built on Shiny and allows you to visualize model training accuracy scores in realtime in 2 steps: +A Shiny app to visualize model training accuracy scores in realtime. + +## Steps * Train multiple models with different parameters locally, and store the accuracy scores to a remote database at the end of every epoch. * The visualisation application dynamically detects changes in the remote database and generates a plot as the training progresses. diff --git a/examples/shiny/express-tip-calculator/README.md b/examples/shiny/express-tip-calculator/README.md new file mode 100644 index 00000000..7a32c48d --- /dev/null +++ b/examples/shiny/express-tip-calculator/README.md @@ -0,0 +1,3 @@ +# Restaurant tipping dashboard + +A restaurant tipping dashboard designed to offer valuable insights into tipping behaviors like average tip, tips percentage over the week, etc. \ No newline at end of file diff --git a/examples/solara/arxiv-chat/README.md b/examples/solara/arxiv-chat/README.md new file mode 100644 index 00000000..794afa3c --- /dev/null +++ b/examples/solara/arxiv-chat/README.md @@ -0,0 +1,3 @@ +# Arxiv Chat + +A chat assistant that can help find academic papers using Arxiv and also allows users to chat with an uploaded article. \ No newline at end of file diff --git a/examples/solara/gpt-4-tokenizer/README.md b/examples/solara/gpt-4-tokenizer/README.md new file mode 100644 index 00000000..f93fcdfb --- /dev/null +++ b/examples/solara/gpt-4-tokenizer/README.md @@ -0,0 +1,3 @@ +# GPT4 Tokenizer + +A Solara app that shows how to use a language model tokenizer to encode and decode and how to search for a token. \ No newline at end of file diff --git a/examples/solara/keyword-extraction/README.md b/examples/solara/keyword-extraction/README.md index 1116eb3f..ef2f9c13 100644 --- a/examples/solara/keyword-extraction/README.md +++ b/examples/solara/keyword-extraction/README.md @@ -1,6 +1,8 @@ # Keyword Extraction Solara App -This Solara app is designed for performing keyword extraction from text documents. Currently, it supports the packages `PyTextRank` and `Yake` for extracting the most relevant keywords from the input text. +This Solara app is designed for performing keyword extraction from text documents. + +Currently, it supports the packages `PyTextRank` and `Yake` for extracting the most relevant keywords from the input text. The extracted keywords can be useful for content analysis, search engine optimization (SEO), and other natural language processing tasks. ## Getting Started diff --git a/examples/solara/ocr/README.md b/examples/solara/ocr/README.md new file mode 100644 index 00000000..e8755805 --- /dev/null +++ b/examples/solara/ocr/README.md @@ -0,0 +1,3 @@ +# OCR app + +A Solara app to extract text from images. \ No newline at end of file diff --git a/examples/solara/personality-quiz-rag/README.md b/examples/solara/personality-quiz-rag/README.md index 9cbd1d71..b8f00b13 100644 --- a/examples/solara/personality-quiz-rag/README.md +++ b/examples/solara/personality-quiz-rag/README.md @@ -1,3 +1,7 @@ +# Personality Quiz + +A RAG application to deduce user's Myers-Briggs personality type from answers to quiz questions. + ## How to run this application locally ### 1. Install dependencies diff --git a/examples/solara/video-rag/README.md b/examples/solara/video-rag/README.md index ac56c828..37653ce7 100644 --- a/examples/solara/video-rag/README.md +++ b/examples/solara/video-rag/README.md @@ -1,5 +1,7 @@ ## RAG from video +A RAG application that takes video content as input and answers questions about it. + This is a full stack project that uses a video as input, populates an ElasticSearch instance with vectors through an indexing pipeline, and initializes a retriver pipeline with a Solara app. A complete walk through of this application can be found [here](https://ploomber.io/blog/rag-video-app/) diff --git a/examples/streamlit/basic-app/README.md b/examples/streamlit/basic-app/README.md new file mode 100644 index 00000000..377c6517 --- /dev/null +++ b/examples/streamlit/basic-app/README.md @@ -0,0 +1,3 @@ +# A basic app + +A basic Streamlit app. \ No newline at end of file diff --git a/examples/streamlit/data-viz/README.md b/examples/streamlit/data-viz/README.md new file mode 100644 index 00000000..875935d6 --- /dev/null +++ b/examples/streamlit/data-viz/README.md @@ -0,0 +1,3 @@ +# Data visualisation + +An interactive app that explores a public Uber dataset for pickups and drop-offs in New York City. \ No newline at end of file diff --git a/examples/voila/animated-viz/README.md b/examples/voila/animated-viz/README.md new file mode 100644 index 00000000..4c03037a --- /dev/null +++ b/examples/voila/animated-viz/README.md @@ -0,0 +1,3 @@ +# Data visualisation + +An interactive app that allows users to explore population by continent or countries. \ No newline at end of file diff --git a/examples/voila/basic-app/README.md b/examples/voila/basic-app/README.md index 615cade7..54e43342 100644 --- a/examples/voila/basic-app/README.md +++ b/examples/voila/basic-app/README.md @@ -1,3 +1,5 @@ -# Custom Voila app +# Scotch data visualisation app + +A dashboard for visualising different properties of the type of scotch selected by the user. `app.ipynb` was taken from the [`voila-gridstack`](https://github.com/voila-dashboards/voila-gridstack/blob/main/examples/scotch_dashboard.ipynb) repository. \ No newline at end of file diff --git a/examples/voila/chat-with-csv/README.md b/examples/voila/chat-with-csv/README.md new file mode 100644 index 00000000..f491f655 --- /dev/null +++ b/examples/voila/chat-with-csv/README.md @@ -0,0 +1,3 @@ +# Chat with a CSV + +Chat with a CSV file using natural language. \ No newline at end of file diff --git a/examples/voila/env-variable/README.md b/examples/voila/env-variable/README.md new file mode 100644 index 00000000..d97ec4e6 --- /dev/null +++ b/examples/voila/env-variable/README.md @@ -0,0 +1,3 @@ +# Environment variable + +A simple app for demonstrating how to access environment variables in Ploomber Cloud. \ No newline at end of file diff --git a/examples/voila/image-mask-generator/README.md b/examples/voila/image-mask-generator/README.md new file mode 100644 index 00000000..5f19adb1 --- /dev/null +++ b/examples/voila/image-mask-generator/README.md @@ -0,0 +1,3 @@ +# Mask generator + +This tool allows you to create mask images, required by inpainting models such as Stable Diffusion Inpainting. \ No newline at end of file diff --git a/examples/voila/jupysql/README.md b/examples/voila/jupysql/README.md new file mode 100644 index 00000000..7601df3c --- /dev/null +++ b/examples/voila/jupysql/README.md @@ -0,0 +1,3 @@ +# Analytical application + +An application that uses the Penguins dataset to demonstrate model prediction values given an input. \ No newline at end of file diff --git a/examples/voila/ml/README.md b/examples/voila/ml/README.md new file mode 100644 index 00000000..4c6a455d --- /dev/null +++ b/examples/voila/ml/README.md @@ -0,0 +1,3 @@ +# Machine Learning + +An application that uses the Penguins dataset to demonstrate model prediction values given an input. \ No newline at end of file diff --git a/examples/voila/mosaic/README.md b/examples/voila/mosaic/README.md new file mode 100644 index 00000000..07d2a50b --- /dev/null +++ b/examples/voila/mosaic/README.md @@ -0,0 +1,3 @@ +# Mosaic visualisation app + +This application uses Mosaic to display plots that are interactive and linked together through cross-filtering. \ No newline at end of file diff --git a/examples/voila/object-removal/README.md b/examples/voila/object-removal/README.md new file mode 100644 index 00000000..1ffd8b15 --- /dev/null +++ b/examples/voila/object-removal/README.md @@ -0,0 +1,3 @@ +# Object Removal app + +This app allows you to remove objects from images. \ No newline at end of file