Initial upload.

.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# mac stuff
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 simatry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,13 +1,17 @@
----
 title: Email Generator
-emoji: 🦀
-colorFrom: green
-colorTo: indigo
+emoji: 📧
+colorFrom: blue
+colorTo: blue
 sdk: gradio
+python_version: 3.9.16
 sdk_version: 3.18.0
 app_file: app.py
 pinned: false
 license: mit
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+models:
+    - pszemraj/opt-350m-email-generation
+    - pszemraj/opt-350m-email-generation
+    - postbot/gpt2-medium-emailgen
+    - sagorsarker/emailgenerator
+tags:
+    - email

app.py

@@ -0,0 +1,52 @@
+import gradio as gr
+
+from email_generator import (
+    generate_email,
+    DEFAULT_GENERATOR, AVAILABLE_GENERATORS
+)
+
+
+with gr.Blocks() as demo:
+    # -- Description.
+    gr.Markdown('# Email Generation')
+    gr.Markdown("""
+        Start an email and let AI do the rest, courtesy of the HuggingFace community!
+        AI is supposed to help automate the boring stuff,
+        and there's nothing more boring to me than writing generic emails.
+        Use this demo to interact with various HuggingFace models for automatic email generation.
+        
+        Select a model from the dropdown list to use a specific pretrained model,
+        or leave it unchanged to default to [pszemraj/opt-350m-email-generation](https://huggingface.co/pszemraj/opt-350m-email-generation).
+        
+        Then you just have to begin your email and click 'Generate Email' to complete it automatically!
+        """
+    )
+    gr.Image('emails/images/bored.jpg', label='Credit: https://unsplash.com/@thomascpark')
+
+    # -- Model parameters.
+    with gr.Row():
+        model_tag = gr.Dropdown(
+            choices=AVAILABLE_GENERATORS,
+            label='Choose a HuggingFace model',
+            value=DEFAULT_GENERATOR
+        )
+        max_tokens = gr.Slider(10, 200, value=64, label='Max Tokens')
+    
+    # -- Prompt.
+    with gr.Row():
+        with gr.Column():
+            prompt = gr.Textbox(
+                lines=4,
+                label='',
+                placeholder='Begin your email here...'
+            )
+            generate_button = gr.Button('Generate Email', variant='primary')
+
+    # -- Output.
+    with gr.Row():
+        output = gr.Textbox(lines=8, label='Output', interactive=False)
+
+    # -- Button actions.
+    generate_button.click(fn=generate_email, inputs=[model_tag, prompt, max_tokens], outputs=output)
+
+demo.launch()

email_generator.py

@@ -0,0 +1,63 @@
+""" Functions for loading email generator."""
+import torch
+import transformers
+
+DEVICE = 0 if torch.cuda.is_available() else -1
+
+AVAILABLE_GENERATORS = [
+    'pszemraj/opt-350m-email-generation',
+    'pszemraj/opt-350m-email-generation',
+    'postbot/gpt2-medium-emailgen',
+    'sagorsarker/emailgenerator'
+]
+DEFAULT_GENERATOR = 'pszemraj/opt-350m-email-generation'
+
+
+class EmailGenerator:
+    """ Class that loads and wraps a HuggingFace email generation pipeline."""
+    def __init__(self, model_tag: str) -> None:
+        """ Initialize HuggingFace email generation pipeline.
+
+        Args:
+            model_tag (str): Model name.
+        """
+        self.tag = model_tag
+        self.generator = transformers.pipeline(
+            'text-generation', model_tag,
+            use_fast=True, do_sample=False,
+            device=DEVICE
+        )
+        
+    def generate(self, prompt: str, max_tokens: int) -> str:
+        """ Generate a sample from a given prompt.
+
+        Args:
+            prompt (str): Prompting for email generator.
+            max_tokens (int): Maximum number of tokens to return.
+
+        Returns:
+            str: Generated text.
+        """
+        output = self.generator(prompt, max_length=max_tokens)
+        return output[0]['generated_text']
+    
+    def __str__(self):
+        return f'EmailGenerator({self.tag})'
+
+def set_global_generator(model_tag: str=DEFAULT_GENERATOR):
+    """ Set global parameter 'generator' as specified EmailGenerator."""
+    global generator
+    generator = EmailGenerator(model_tag=model_tag)
+        
+def generator_exists():
+    """ Check if global variable 'generator' has been defined."""
+    return 'generator' in globals()
+
+def generate_email(model_tag: str, prompt: str, max_tokens: int):
+    """ Check for generator and create prompt.
+    Initialize correct generator if incorrect generator or no generator is found.
+    """
+    if not generator_exists() or generator.tag != model_tag:
+        set_global_generator(model_tag=model_tag)
+    
+    return generator.generate(prompt, max_tokens=max_tokens)

requirements.txt

@@ -0,0 +1,2 @@
+transformers==4.26.1
+gradio==3.18.0