Duplicate from hysts/space-that-creates-model-demo-space

Co-authored-by: hysts <hysts@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,31 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.2.0
+  hooks:
+  - id: check-executables-have-shebangs
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-shebang-scripts-are-executable
+  - id: check-toml
+  - id: check-yaml
+  - id: double-quote-string-fixer
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+    args: ['--fix=lf']
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/myint/docformatter
+  rev: v1.4
+  hooks:
+  - id: docformatter
+    args: ['--in-place']
+- repo: https://github.com/pycqa/isort
+  rev: 5.10.1
+  hooks:
+    - id: isort
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.812
+  hooks:
+    - id: mypy
+      args: ['--ignore-missing-imports']
+- repo: https://github.com/google/yapf
+  rev: v0.32.0
+  hooks:
+  - id: yapf
+    args: ['--parallel', '--in-place']
+- repo: https://github.com/kynan/nbstripout
+  rev: 0.5.0
+  hooks:
+    - id: nbstripout
+      args: ['--extra-keys', 'metadata.interpreter metadata.kernelspec cell.metadata.pycharm']
+- repo: https://github.com/nbQA-dev/nbQA
+  rev: 1.3.1
+  hooks:
+    - id: nbqa-isort
+    - id: nbqa-yapf

.style.yapf

@@ -0,0 +1,5 @@
+[style]
+based_on_style = pep8
+blank_line_before_nested_class_or_def = false
+spaces_before_comment = 2
+split_before_logical_operator = true

README.md

@@ -0,0 +1,13 @@
+---
+title: Space That Creates Model Demo Space
+emoji: 🐠
+colorFrom: yellow
+colorTo: yellow
+sdk: gradio
+sdk_version: 3.1.6
+app_file: app.py
+pinned: false
+duplicated_from: hysts/space-that-creates-model-demo-space
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -0,0 +1,173 @@
+#!/usr/bin/env python
+
+from __future__ import annotations
+
+import shutil
+import tempfile
+
+import gradio as gr
+from huggingface_hub import HfApi
+
+title = 'Model Demo Creation'
+description = '''
+With this Space, you can create a demo Space for models that are loadable with `gradio.Interface.load` in [Model Hub](https://huggingface.co/models).
+The Space will be created under your account and private.
+You need a token with write permission (See: https://huggingface.co/settings/tokens).
+
+You can specify multiple model names by listing them separated by commas.
+If you specify multiple model names, the resulting Space will show all the outputs of those models side by side for the given inputs.
+'''
+article = ''
+examples = [
+    [
+        'resnet-50',
+        'microsoft/resnet-50',
+        '',
+        'Demo for microsoft/resnet-50',
+        '',
+        '',
+    ],
+    [
+        'compare-image-classification-models',
+        'google/vit-base-patch16-224, microsoft/resnet-50',
+        '',
+        'Compare Image Classification Models',
+        '',
+        '',
+    ],
+    [
+        'compare-text-generation-models',
+        'EleutherAI/gpt-j-6B, EleutherAI/gpt-neo-1.3B',
+        '',
+        'Compare Text Generation Models',
+        '',
+        '',
+    ],
+]
+
+api = HfApi()
+
+
+def check_if_model_exists(model_name: str) -> bool:
+    return any(info.modelId == model_name
+               for info in api.list_models(search=model_name))
+
+
+def check_if_model_loadable(model_name: str) -> bool:
+    try:
+        gr.Interface.load(model_name, src='models')
+    except Exception:
+        return False
+    return True
+
+
+def get_model_io_types(
+        model_name: str) -> tuple[tuple[str, ...], tuple[str, ...]]:
+    iface = gr.Interface.load(model_name, src='models')
+    inputs = tuple(map(str, iface.input_components))
+    outputs = tuple(map(str, iface.output_components))
+    return inputs, outputs
+
+
+def check_if_model_io_is_consistent(model_names: list[str]) -> bool:
+    if len(model_names) == 1:
+        return True
+
+    inputs0, outputs0 = get_model_io_types(model_names[0])
+    for name in model_names[1:]:
+        inputs, outputs = get_model_io_types(name)
+        if inputs != inputs0 or outputs != outputs0:
+            return False
+    return True
+
+
+def save_space_info(dirname: str, filename: str, content: str) -> None:
+    with open(f'{dirname}/{filename}', 'w') as f:
+        f.write(content)
+
+
+def run(space_name: str, model_names_str: str, hf_token: str, title: str,
+        description: str, article: str) -> str:
+    if space_name == '':
+        return 'Space Name must be specified.'
+    if model_names_str == '':
+        return 'Model Names must be specified.'
+    if hf_token == '':
+        return 'Hugging Face Token must be specified.'
+
+    model_names = [name.strip() for name in model_names_str.split(',')]
+    model_names_str = '\n'.join(model_names)
+
+    missing_models = [
+        name for name in model_names if not check_if_model_exists(name)
+    ]
+    if len(missing_models) > 0:
+        message = 'The following models were not found: '
+        for model_name in missing_models:
+            message += f'\n{model_name}'
+        return message
+
+    non_loadable_models = [
+        name for name in model_names if not check_if_model_loadable(name)
+    ]
+    if len(non_loadable_models) > 0:
+        message = 'The following models are not loadable with gradio.Interface.load: '
+        for model_name in non_loadable_models:
+            message += f'\n{model_name}'
+        return message
+
+    if not check_if_model_io_is_consistent(model_names):
+        return 'The inputs and outputs of each model must be the same.'
+
+    user_name = api.whoami(token=hf_token)['name']
+    repo_id = f'{user_name}/{space_name}'
+    try:
+        space_url = api.create_repo(repo_id=repo_id,
+                                    repo_type='space',
+                                    private=True,
+                                    token=hf_token,
+                                    space_sdk='gradio')
+    except Exception as e:
+        return str(e)
+
+    with tempfile.TemporaryDirectory() as temp_dir:
+        shutil.copy('assets/template.py', f'{temp_dir}/app.py')
+        save_space_info(temp_dir, 'TITLE', title)
+        save_space_info(temp_dir, 'DESCRIPTION', description)
+        save_space_info(temp_dir, 'ARTICLE', article)
+        save_space_info(temp_dir, 'MODEL_NAMES', model_names_str)
+        api.upload_folder(repo_id=repo_id,
+                          folder_path=temp_dir,
+                          path_in_repo='.',
+                          token=hf_token,
+                          repo_type='space')
+
+    return f'Successfully created: {space_url}'
+
+
+gr.Interface(
+    fn=run,
+    inputs=[
+        gr.Textbox(
+            label='Space Name',
+            placeholder=
+            'e.g. demo-resnet-50. The Space will be created under your account and private.'
+        ),
+        gr.Textbox(label='Model Names',
+                   placeholder='e.g. microsoft/resnet-50'),
+        gr.Textbox(
+            label='Hugging Face Token',
+            placeholder=
+            'This should be a token with write permission. See: https://huggingface.co/settings/tokens'
+        ),
+        gr.Textbox(label='Title (Optional)'),
+        gr.Textbox(label='Description (Optional)'),
+        gr.Textbox(label='Article (Optional)'),
+    ],
+    outputs=gr.Textbox(label='Output'),
+    title=title,
+    description=description,
+    article=article,
+    examples=examples,
+    cache_examples=False,
+).launch(enable_queue=True, share=False)

assets/template.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+
+from __future__ import annotations
+
+import gradio as gr
+
+
+def read_info(file_name: str) -> str:
+    with open(file_name) as f:
+        content = f.read()
+    return content
+
+
+def load_model(model_name: str) -> gr.Interface:
+    iface = gr.Interface.load(model_name, src='models')
+    for component in iface.output_components:
+        component.label = f'{component.label} ({model_name})'
+    return iface
+
+
+def load_models(model_names: list[str]) -> list[gr.Interface]:
+    return [load_model(name) for name in model_names]
+
+
+title = read_info('TITLE')
+description = read_info('DESCRIPTION')
+article = read_info('ARTICLE')
+model_names = read_info('MODEL_NAMES').split('\n')
+
+interfaces = load_models(model_names)
+gr.Parallel(
+    *interfaces,
+    title=title,
+    description=description,
+    article=article,
+).launch()