Upload 15 files

.streamlit/config.toml

@@ -0,0 +1,3 @@
+[theme]
+base="light"
+primaryColor="#29B4E8"

Demo.py

@@ -0,0 +1,141 @@
+import streamlit as st
+import sparknlp
+import os
+import pandas as pd
+
+from sparknlp.base import *
+from sparknlp.annotator import *
+from pyspark.ml import Pipeline
+from sparknlp.pretrained import PretrainedPipeline
+from streamlit_tags import st_tags
+
+# Page configuration
+st.set_page_config(
+    layout="wide", 
+    initial_sidebar_state="auto"
+)
+
+# CSS for styling
+st.markdown("""
+    <style>
+        .main-title {
+            font-size: 36px;
+            color: #4A90E2;
+            font-weight: bold;
+            text-align: center;
+        }
+        .section {
+            background-color: #f9f9f9;
+            padding: 10px;
+            border-radius: 10px;
+            margin-top: 10px;
+        }
+        .section p, .section ul {
+            color: #666666;
+        }
+    </style>
+""", unsafe_allow_html=True)
+
+@st.cache_resource
+def init_spark():
+    return sparknlp.start()
+
+@st.cache_resource
+def create_pipeline(model, labels):
+    image_assembler = ImageAssembler() \
+        .setInputCol("image") \
+        .setOutputCol("image_assembler")
+
+    imageClassifier = CLIPForZeroShotClassification \
+        .pretrained() \
+        .setInputCols(["image_assembler"]) \
+        .setOutputCol("label") \
+        .setCandidateLabels(labels)
+
+    pipeline = Pipeline(stages=[
+        image_assembler,
+        imageClassifier,
+    ])
+    return pipeline
+
+def fit_data(pipeline, data):
+    model = pipeline.fit(data)
+    light_pipeline = LightPipeline(model)
+    annotations_result = light_pipeline.fullAnnotateImage(data)
+    return annotations_result[0]['label'][0].result
+
+def save_uploadedfile(uploadedfile):
+    filepath = os.path.join(IMAGE_FILE_PATH, uploadedfile.name)
+    with open(filepath, "wb") as f:
+        if hasattr(uploadedfile, 'getbuffer'):
+            f.write(uploadedfile.getbuffer())
+        else:
+            f.write(uploadedfile.read())
+        
+# Sidebar content
+model = st.sidebar.selectbox(
+    "Choose the pretrained model",
+    ["CLIPForZeroShotClassification"],
+    help="For more info about the models visit: https://sparknlp.org/models"
+)
+
+# Set up the page layout
+st.markdown(f'<div class="main-title">CLIPForZeroShotClassification</div>', unsafe_allow_html=True)
+# st.markdown(f'<div class="section"><p>{sub_title}</p></div>', unsafe_allow_html=True)
+
+# Reference notebook link in sidebar
+link = """
+<a href="https://github.com/JohnSnowLabs/spark-nlp/blob/master/examples/python/annotation/image/CLIPForZeroShotClassification.ipynb">
+    <img src="https://colab.research.google.com/assets/colab-badge.svg" style="zoom: 1.3" alt="Open In Colab"/>
+</a>
+"""
+st.sidebar.markdown('Reference notebook:')
+st.sidebar.markdown(link, unsafe_allow_html=True)
+
+# Load examples
+IMAGE_FILE_PATH = "/content/sparknlp CLIPForZeroShotClassification/input"
+image_files = sorted([file for file in os.listdir(IMAGE_FILE_PATH) if file.split('.')[-1]=='png' or file.split('.')[-1]=='jpg' or file.split('.')[-1]=='JPEG' or file.split('.')[-1]=='jpeg'])
+
+img_options = st.selectbox("Select an image", image_files)
+uploadedfile = st.file_uploader("Try it for yourself!")
+
+if uploadedfile:
+    file_details = {"FileName":uploadedfile.name,"FileType":uploadedfile.type}
+    save_uploadedfile(uploadedfile)
+    selected_image = f"{IMAGE_FILE_PATH}/{uploadedfile.name}"
+elif img_options:
+    selected_image = f"{IMAGE_FILE_PATH}/{img_options}"
+
+candidateLabels = [
+    "a photo of a bird",
+    "a photo of a cat",
+    "a photo of a dog",
+    "a photo of a hen",
+    "a photo of a hippo",
+    "a photo of a room",
+    "a photo of a tractor",
+    "a photo of an ostrich",
+    "a photo of an ox"]
+
+lables = st_tags(
+    label='Select labels',
+    text='Press enter to add more',
+    value=candidateLabels,
+    maxtags = -1)
+
+st.subheader('Classified Image')
+
+image_size = st.slider('Image Size', 400, 1000, value=400, step = 100)
+
+try:
+    st.image(f"{IMAGE_FILE_PATH}/{selected_image}", width=image_size)
+except:
+    st.image(selected_image, width=image_size)
+
+st.subheader('Classification')
+
+init_spark()
+Pipeline = create_pipeline(model, lables)
+output = fit_data(Pipeline, selected_image)
+
+st.markdown(f'This document has been classified as  : **{output}**')

Dockerfile

@@ -0,0 +1,70 @@
+# Download base image ubuntu 18.04
+FROM ubuntu:18.04
+
+# Set environment variables
+ENV NB_USER jovyan
+ENV NB_UID 1000
+ENV HOME /home/${NB_USER}
+
+# Install required packages
+RUN apt-get update && apt-get install -y \
+    tar \
+    wget \
+    bash \
+    rsync \
+    gcc \
+    libfreetype6-dev \
+    libhdf5-serial-dev \
+    libpng-dev \
+    libzmq3-dev \
+    python3 \
+    python3-dev \
+    python3-pip \
+    unzip \
+    pkg-config \
+    software-properties-common \
+    graphviz \
+    openjdk-8-jdk \
+    ant \
+    ca-certificates-java \
+    && apt-get clean \
+    && update-ca-certificates -f;
+
+# Install Python 3.8 and pip
+RUN add-apt-repository ppa:deadsnakes/ppa \
+    && apt-get update \
+    && apt-get install -y python3.8 python3-pip \
+    && apt-get clean;
+
+# Set up JAVA_HOME
+ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
+RUN mkdir -p ${HOME} \
+    && echo "export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/" >> ${HOME}/.bashrc \
+    && chown -R ${NB_UID}:${NB_UID} ${HOME}
+
+# Create a new user named "jovyan" with user ID 1000
+RUN useradd -m -u ${NB_UID} ${NB_USER}
+
+# Switch to the "jovyan" user
+USER ${NB_USER}
+
+# Set home and path variables for the user
+ENV HOME=/home/${NB_USER} \
+    PATH=/home/${NB_USER}/.local/bin:$PATH
+
+# Set the working directory to the user's home directory
+WORKDIR ${HOME}
+
+# Upgrade pip and install Python dependencies
+RUN python3.8 -m pip install --upgrade pip
+COPY requirements.txt /tmp/requirements.txt
+RUN python3.8 -m pip install -r /tmp/requirements.txt
+
+# Copy the application code into the container at /home/jovyan
+COPY --chown=${NB_USER}:${NB_USER} . ${HOME}
+
+# Expose port for Streamlit
+EXPOSE 7860
+
+# Define the entry point for the container
+ENTRYPOINT ["streamlit", "run", "Demo.py", "--server.port=7860", "--server.address=0.0.0.0"]

pages/Workflow & Model Overview.py

@@ -0,0 +1,246 @@
+import streamlit as st
+
+# Custom CSS for better styling
+st.markdown("""
+    <style>
+        .main-title {
+            font-size: 36px;
+            color: #4A90E2;
+            font-weight: bold;
+            text-align: center;
+        }
+        .sub-title {
+            font-size: 24px;
+            color: #4A90E2;
+            margin-top: 20px;
+        }
+        .section {
+            background-color: #f9f9f9;
+            padding: 15px;
+            border-radius: 10px;
+            margin-top: 20px;
+        }
+        .section h2 {
+            font-size: 22px;
+            color: #4A90E2;
+        }
+        .section p, .section ul {
+            color: #666666;
+        }
+        .link {
+            color: #4A90E2;
+            text-decoration: none;
+        }
+        .benchmark-table {
+            width: 100%;
+            border-collapse: collapse;
+            margin-top: 20px;
+        }
+        .benchmark-table th, .benchmark-table td {
+            border: 1px solid #ddd;
+            padding: 8px;
+            text-align: left;
+        }
+        .benchmark-table th {
+            background-color: #4A90E2;
+            color: white;
+        }
+        .benchmark-table td {
+            background-color: #f2f2f2;
+        }
+    </style>
+""", unsafe_allow_html=True)
+
+# Main Title
+st.markdown('<div class="main-title">Image Zero Shot Classification with CLIP</div>', unsafe_allow_html=True)
+
+# Description
+st.markdown("""
+<div class="section">
+    <p><strong>CLIP (Contrastive Language-Image Pre-Training)</strong> is a neural network trained on image and text pairs. It has the capability to classify images without requiring hard-coded labels, making it highly flexible. Labels can be provided during inference, similar to the zero-shot capabilities of GPT-2 and GPT-3 models.</p>
+    <p>This model was imported from Hugging Face Transformers: <a class="link" href="https://huggingface.co/openai/clip-vit-base-patch32" target="_blank">CLIP Model on Hugging Face</a></p>
+</div>
+""", unsafe_allow_html=True)
+
+# How to Use
+st.markdown('<div class="sub-title">How to Use the Model</div>', unsafe_allow_html=True)
+st.code('''
+import sparknlp
+from sparknlp.base import *
+from sparknlp.annotator import *
+from pyspark.ml import Pipeline
+
+# Load image data
+imageDF = spark.read \\
+    .format("image") \\
+    .option("dropInvalid", value = True) \\
+    .load("src/test/resources/image/")
+
+# Define Image Assembler
+imageAssembler: ImageAssembler = ImageAssembler() \\
+    .setInputCol("image") \\
+    .setOutputCol("image_assembler")
+
+# Define candidate labels
+candidateLabels = [
+    "a photo of a bird",
+    "a photo of a cat",
+    "a photo of a dog",
+    "a photo of a hen",
+    "a photo of a hippo",
+    "a photo of a room",
+    "a photo of a tractor",
+    "a photo of an ostrich",
+    "a photo of an ox"]
+
+# Define CLIP classifier
+imageClassifier = CLIPForZeroShotClassification \\
+    .pretrained() \\
+    .setInputCols(["image_assembler"]) \\
+    .setOutputCol("label") \\
+    .setCandidateLabels(candidateLabels)
+
+# Create pipeline
+pipeline = Pipeline().setStages([imageAssembler, imageClassifier])
+
+# Apply pipeline to image data
+pipelineDF = pipeline.fit(imageDF).transform(imageDF)
+
+# Show results
+pipelineDF \\
+  .selectExpr("reverse(split(image.origin, '/'))[0] as image_name", "label.result") \\
+  .show(truncate=False)
+''', language='python')
+
+# Results
+st.markdown('<div class="sub-title">Results</div>', unsafe_allow_html=True)
+st.markdown("""
+<div class="section">
+    <table class="benchmark-table">
+        <tr>
+            <th>Image Name</th>
+            <th>Result</th>
+        </tr>
+        <tr>
+            <td>palace.JPEG</td>
+            <td>[a photo of a room]</td>
+        </tr>
+        <tr>
+            <td>egyptian_cat.jpeg</td>
+            <td>[a photo of a cat]</td>
+        </tr>
+        <tr>
+            <td>hippopotamus.JPEG</td>
+            <td>[a photo of a hippo]</td>
+        </tr>
+        <tr>
+            <td>hen.JPEG</td>
+            <td>[a photo of a hen]</td>
+        </tr>
+        <tr>
+            <td>ostrich.JPEG</td>
+            <td>[a photo of an ostrich]</td>
+        </tr>
+        <tr>
+            <td>junco.JPEG</td>
+            <td>[a photo of a bird]</td>
+        </tr>
+        <tr>
+            <td>bluetick.jpg</td>
+            <td>[a photo of a dog]</td>
+        </tr>
+        <tr>
+            <td>chihuahua.jpg</td>
+            <td>[a photo of a dog]</td>
+        </tr>
+        <tr>
+            <td>tractor.JPEG</td>
+            <td>[a photo of a tractor]</td>
+        </tr>
+        <tr>
+            <td>ox.JPEG</td>
+            <td>[a photo of an ox]</td>
+        </tr>
+    </table>
+</div>
+""", unsafe_allow_html=True)
+
+# Model Information
+st.markdown('<div class="sub-title">Model Information</div>', unsafe_allow_html=True)
+st.markdown("""
+<div class="section">
+    <table class="benchmark-table">
+        <tr>
+            <th>Attribute</th>
+            <th>Description</th>
+        </tr>
+        <tr>
+            <td><strong>Model Name</strong></td>
+            <td>zero_shot_classifier_clip_vit_base_patch32</td>
+        </tr>
+        <tr>
+            <td><strong>Compatibility</strong></td>
+            <td>Spark NLP 5.2.0+</td>
+        </tr>
+        <tr>
+            <td><strong>License</strong></td>
+            <td>Open Source</td>
+        </tr>
+        <tr>
+            <td><strong>Edition</strong></td>
+            <td>Official</td>
+        </tr>
+        <tr>
+            <td><strong>Input Labels</strong></td>
+            <td>[image_assembler]</td>
+        </tr>
+        <tr>
+            <td><strong>Output Labels</strong></td>
+            <td>[classification]</td>
+        </tr>
+        <tr>
+            <td><strong>Language</strong></td>
+            <td>en</td>
+        </tr>
+        <tr>
+            <td><strong>Size</strong></td>
+            <td>392.8 MB</td>
+        </tr>
+    </table>
+</div>
+""", unsafe_allow_html=True)
+
+# Data Source Section
+st.markdown('<div class="sub-title">Data Source</div>', unsafe_allow_html=True)
+st.markdown("""
+<div class="section">
+    <p>The CLIP model is available on <a class="link" href="https://huggingface.co/openai/clip-vit-base-patch32" target="_blank">Hugging Face</a>. This model was trained on image-text pairs and can be used for zero-shot image classification.</p>
+</div>
+""", unsafe_allow_html=True)
+
+# References
+st.markdown('<div class="sub-title">References</div>', unsafe_allow_html=True)
+st.markdown("""
+<div class="section">
+    <ul>
+        <li><a class="link" href="https://sparknlp.org/2023/12/02/zero_shot_classifier_clip_vit_base_patch32_en.html" target="_blank" rel="noopener">CLIP Model on Spark NLP</a></li>
+        <li><a class="link" href="https://huggingface.co/openai/clip-vit-base-patch32" target="_blank" rel="noopener">CLIP Model on Hugging Face</a></li>
+        <li><a class="link" href="https://github.com/openai/CLIP" target="_blank" rel="noopener">CLIP GitHub Repository</a></li>
+        <li><a class="link" href="https://arxiv.org/abs/2103.00020" target="_blank" rel="noopener">CLIP Paper</a></li>
+    </ul>
+</div>
+""", unsafe_allow_html=True)
+
+# Community & Support
+st.markdown('<div class="sub-title">Community & Support</div>', unsafe_allow_html=True)
+st.markdown("""
+<div class="section">
+    <ul>
+        <li><a class="link" href="https://sparknlp.org/" target="_blank">Official Website</a>: Documentation and examples</li>
+        <li><a class="link" href="https://join.slack.com/t/spark-nlp/shared_invite/zt-198dipu77-L3UWNe_AJ8xqDk0ivmih5Q" target="_blank">Slack</a>: Live discussion with the community and team</li>
+        <li><a class="link" href="https://github.com/JohnSnowLabs/spark-nlp" target="_blank">GitHub</a>: Bug reports, feature requests, and contributions</li>
+        <li><a class="link" href="https://medium.com/spark-nlp" target="_blank">Medium</a>: Spark NLP articles</li>
+        <li><a class="link" href="https://www.youtube.com/channel/UCmFOjlpYEhxf_wJUDuz6xxQ/videos" target="_blank">YouTube</a>: Video tutorials</li>
+    </ul>
+</div>
+""", unsafe_allow_html=True)

requirements.txt

@@ -0,0 +1,6 @@
+streamlit
+streamlit-tags
+pandas
+numpy
+spark-nlp
+pyspark