Initial deploy

README.md

@@ -1,12 +1,81 @@
 ---
 title: Cat Breed Classifier
-emoji: 📈
-colorFrom: blue
-colorTo: green
+emoji: 🐱
+colorFrom: green
+colorTo: red
 sdk: gradio
 sdk_version: 3.16.1
 app_file: app.py
 pinned: false
+license: openrail
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# \[EN\] Cat Breed Classifier
+
+This is an app that can classify the breed of a cat based on a photo.
+
+It uses a VGG-16 ImageNet model finetuned on images of cats of various breeds. The model is able to recognize a 20 of breeds.
+
+## Requirements
+
+- Python 3.8 or higher
+- Gradio 3.15.0
+- Tensorflow 2.10
+- Numpy 1.23.3
+- Requests 2.25.1
+- Pillow 9.0.1
+- FastApi 0.88.0
+- Uvicorn 0.20.0 or higher
+
+## How to use
+
+1. Clone repository using `git clone https://github.com/DenkingOfficial/cat_breed_classifier.git`
+2. Enter the cloned directory `cd cat_breed_classifier`
+3. Install requirements by running `pip install -r requirements.txt`
+4. Download a model from [here](https://www.dropbox.com/s/iga6rfyqpq0lnra/20_cat_classes_model.h5) and place it into `models` folder
+5. Run app using `uvicorn app:app`
+
+## Authors
+
+This app was developed by students of Ural Federal University (UrFU):
+
+- Shershnev Andrey, RIM-120907 - Model Training, App Development
+- Ivanov Sergey, RIM-120906 - API Development, Dataset collection
+- Shalaeva Irina, RIM-120906 - UI Styling, Dataset collection
+- Ilyin Semen, RIM-120907 - App Development, Dataset collection
+
+---
+
+# \[RU\] Классификатор пород кошек
+
+Это веб-приложение, которое позволяет определять породу кошки по фотографии.
+
+Оно использует модель VGG-16 ImageNet тонко настроенную на изображениях кошек разных пород. Данная модель позволяет определять 20 пород.
+
+## Зависимости
+
+- Python 3.8 или новее
+- Gradio 3.15.0
+- Tensorflow 2.10
+- Numpy 1.23.3
+- Requests 2.25.1
+- Pillow 9.0.1
+- FastApi 0.88.0
+- Uvicorn 0.20.0 или новее
+
+## Как использовать
+
+1. Загрузить репозиторий используя команду `git clone https://github.com/DenkingOfficial/cat_breed_classifier.git`
+2. Перейти в директорию репозитория `cd cat_breed_classifier`
+3. Установить зависимости используя команду `pip install -r requirements.txt`
+4. Скачать модель [отсюда](https://www.dropbox.com/s/iga6rfyqpq0lnra/20_cat_classes_model.h5) и скопировать ее в папку `models`
+5. Запустить приложение используя команду `uvicorn app:app`
+
+## Авторы
+
+Это приложение было разработано студентами Уральского Федерального университета (УрФУ):
+
+- Шершнев Андрей, РИМ-120907 - тренировка модели, разработка приложения
+- Иванов Сергей, РИМ-120906 - разработка API, сбор датасета
+- Шалаева Ирина, РИМ-120906 - стилизация интерфейса, сбор датасета
+- Ильин Семен, РИМ-120907 - разработка приложения, сбор датасета

app.py

@@ -0,0 +1,3 @@
+import subprocess
+
+subprocess.run("uvicorn main_app:app --host 0.0.0.0 --port 7860", shell=True)

cat_breeds_dict.py

@@ -0,0 +1,107 @@
+CAT_BREEDS = ['Бенгальская', 'Бомбейская', 'Бритнаская короткошерстная',
+              'Бурмилла', 'Девон-рекс', 'Европейская короткошерстная',
+              'Экзотическая короткошерстная', 'Мейн-кун', 'Нибелунг',
+              'Персидская', 'Питерболд', 'Рэгдолл', 'Русская голубая',
+              'Саванна', 'Шотландская вислоухая', 'Сибирская', 'Сингапурская',
+              'Сомалийская', 'Сфинкс', 'Черепаховая']
+
+CAT_DESCRIPTIONS = {'Бенгальская':
+                        '''# Бенгальская кошка
+                           ### Бенгальская кошка — крупная кошка с блестящей шерстью, очень развитой мускулатурой и толстым хвостом, который часто свисает до земли. Бенгальская кошка внешне напоминает дикую кошку: характерная густая роскошная шерсть имеет пятнистый окрас и мраморные разводы. На широкой голове располагаются небольшие уши и бакенбарды, глаза имеют миндалевидную форму и чёрную окантовку. Хвост толстый, сужается к чёрному кончику. Ни одна другая порода кошек не имеет такого эффекта золотистого или жемчужного мерцания шерсти, который можно обнаружить у бенгальских кошек.
+                        ''',
+
+                    'Бомбейская':
+                        '''# Бомбейская кошка
+                           ### Бомбейская кошка (бомбей) – питомец-компаньон для активных и жизнерадостных людей, проводящих большую часть свободного времени дома. Порода задумана как мини-версия черной пантеры. Однако от хищной кошки унаследовала только экстерьер. В то время как характер больше напоминает собаку. Породистый бомбей демонстрирует безусловную преданность и любовь к человеку, не отказывается от игры в апорт и легко запоминает базовые команды. К тому же представители породы умны и эмпатичны: животное тонко чувствует настроение хозяина и подстраивается даже под незначительные его изменения.Бомбейская кошка (бомбей) – питомец-компаньон для активных и жизнерадостных людей, проводящих большую часть свободного времени дома. Порода задумана как мини-версия черной пантеры. Однако от хищной кошки унаследовала только экстерьер. В то время как характер больше напоминает собаку. Породистый бомбей демонстрирует безусловную преданность и любовь к человеку, не отказывается от игры в апорт и легко запоминает базовые команды. К тому же представители породы умны и эмпатичны: животное тонко чувствует настроение хозяина и подстраивается даже под незначительные его изменения.
+                        ''',
+
+                    'Бритнаская короткошерстная':
+                        '''# Бритнаская короткошерстная
+                           ### Британская короткошёрстная — крупная порода, имеющая массивное, коренастое телосложение. У представителей этой породы широкая грудная клетка и толстый хвост. Морда, уши, глаза и голова — имеют округлую форму. У кошки короткий широкий нос и массивная нижняя челюсть. Шерсть у британских короткошёрстных — короткая и густая, без пушистости, бывает более ста окрасов и имеет множество комбинаций пятен.
+                        ''',
+
+                    'Бурмилла':
+                        '''# Бурмилла
+                           ### Бурмилла — кошка среднего телосложения, похожая на бурмезскую. Порода отличается коренастым и довольно мускулистым телом и широкой прямой спиной. Самки намного мельче и изящнее самцов. Форма головы — слегка скругленный конус. Представители этой породы имеют клиновидный нос и широко посаженные уши. Цвет глаз варьируется от золотисто-желтого до зеленого. Отличительной особенностью этой породы является характерная отметина на лбу в виде буквы M. Короткая шерсть со светлым подшерстком близко прилегает к телу и отличается равномерным типпингом (кончики волосков более темного цвета) по всему телу.
+                        ''',
+
+                    'Девон-рекс':
+                        '''# Девон-рекс
+                           ### Запоминающийся образ кошки породы девон-рекс — это ехидная мордочка с волнистой «мятой» шерстью. Широкие скулы, большие глаза, низко посаженные уши. Короткая шерсть имеет волнистые остевые волосы, но в основном состоит из пухового подшерстка. Шерсть девон-рекса имеет характерную «марсельскую волну», особенно на спине, где образуются мелкие барашки. Бакенбарды и надбровные дуги у этой породы также волнистые. Девон-рекс может быть любых окрасов и вариантов пятнистости.
+                        ''',
+
+                    'Европейская короткошерстная':
+                        '''# Европейская короткошерстная
+                           ### Европейская короткошерстная кошка, она же кельтская, на первый взгляд выглядит как обычная довольно крупная домашняя кошка. Тем не менее генетики выяснили, что она наследует кошкам, охранявшим амбары европейских крестьян 2000 лет назад! И это как минимум. Каждая кельтская кошка отличаются своим характером: одни любят прогулки, другие предпочитают наблюдать жизнь из окна; одни более общительны, другие менее. Но все они хорошие компаньоны: уравновешенные, жизнерадостные, ласковые без навязчивости, готовые и поиграть, и просто составить компанию на диване перед телевизором.
+                        ''',
+
+                    'Экзотическая короткошерстная':
+                        '''# Экзотическая короткошерстная
+                           ### Экзотическая короткошерстная кошка среднего размера. Телосложение — коренастое и в то же время подтянутое. Имеет широкую, круглую голову с небольшими, широко посаженными ушами. У этой кошки маленькая открытая мордочка с большими яркими глазами. Имеет короткие и сильные лапы, с крупными округлыми стопами. Хвост небольшой длины, при этом достаточно пушистый. Шерсть — короткая, густая, с плотным мягким подшерстком. Экзотическая короткошерстная кошка бывает многих окрасов и вариантов пятнистости, типичных для персидской породы, а также может иметь окрас «пятнистый табби».
+                        ''',
+
+                    'Мейн-кун':
+                        '''# Мейн-кун
+                           ### Мейн-кун – это популярная порода кошек, завоевавшая ��оклонников по всему миру своим харизматичным внешним видом и внушительными размерами. Даже обычным людям, совсем не разбирающимся в породах, легко отличить мейн-куна от других кошек благодаря их выдающимся внешним данным. Мейн-кун гордо носит звание пушистого великана.
+                        ''',
+
+                    'Нибелунг':
+                        '''# Нибелунг
+                           ### Нибелунг — редкая порода домашних кошек. Она считается длинношёрстным вариантом русской голубой кошки. Представители этой породы замкнуты и не «горласты», но иногда могут громко мяукать дожидаясь хозяина. Обладают не требующей ежедневного ухода голубой шерстью с серебристым типпингом. Остевые волосы шерсти нибелунга отражают свет, тем самым создавая серебристый отлив. Окрас шерсти и подшёрстка — сплошной голубой. Порода названа в честь «порождения тумана» (от нем. Nebel — туман) из средневекового немецкого эпоса «Песнь о Нибелунгах».
+                        ''',
+
+                    'Персидская':
+                        '''# Персидская
+                           ### Персидская длинношерстная кошка — порода среднего размера, с коренастым телом и с массивной головой. Уши — небольшие, широко посаженные. У этой кошки маленькая открытая мордочка с большими яркими глазами. Имеет короткие и сильные лапы с крупными округлыми основаниями и кисточками между подушечек. Шерсть — длинная, густая и блестящая, с плотным мягким подшерстком. Имеет короткий, но необыкновенно пушистый хвост. Допускаются разные варианты окрасов и пятнистости.
+                        ''',
+
+                    'Питерболд':
+                        '''# Питерболд
+                           ### Питерболд — выведенная в России порода бесшёрстных домашних кошек. Питерболды имеют характерную форму головы: длинную и узкую, с прямым профилем, миндалевидными глазами и большими, разведёнными в стороны ушами. Идеальные представители породы выглядят, как бесшёрстные ориентальные кошки. Питерболды обычно дружелюбны, любопытны, активны, любят всех членов своей семьи и нуждаются в общении с людьми; они не принадлежат к независимым кошкам. Питерболды хорошо уживаются с другими кошками и прочими домашними животными.
+                        ''',
+
+                    'Рэгдолл':
+                        '''# Рэгдолл
+                           ### Рэгдолл — крупная и величавая кошка с характерным окрасом. Представители этой породы обычно расслаблены, невозмутимы и кажутся ленивыми. Голова широкая, имеет плоскую верхнюю часть, с широко расположенными ушами. У рэгдолла большие глаза насыщенного голубого цвета. Тело — длинное и мускулистое, с широкой грудной клеткой, короткой шеей и крупными круглыми лапами с кисточками между подушечек. Хвост — длинный и пушистый. Шерсть рэгдоллов шелковистая и густая, средней длины или длинная. Для взрослых кошек типично «кольцо» шерсти вокруг шеи и пушистые «штанишки». Встречаются три вида окраса: колор-пойнт (у таких кошек светлое тело, но тёмные отдельн��е его части: лапы, хвост, уши и морда), би-колор (один из типов окрасов кошек с белыми пятнами, которые занимают от 1/3 до 1/2 всего тела) и миттед (один из типов окрасов кошек с белыми пятнами, которые занимают от 1/4 до 1/3 всего тела).
+                        ''',
+
+                    'Русская голубая':
+                        '''# Русская голубая
+                           ### Кошки породы русская голубая бывают среднего или крупного размера. Имеют изящное тело и длинные, стройные ноги. Эта кошка настолько грациозна, что кажется, будто она передвигается на цыпочках. Голова имеет клинообразную форму с выдающейся зоной бакенбард и крупные уши. Яркие зеленые глаза широко посажены и имеют миндалевидную форму. По текстуре шерсть русской голубой непохожа на шерсть кошек других пород, и это основная отличительная особенность породы. Шерстка у этих животных — двойная, с густым подшерстком, короткая и приятная на ощупь. Несмотря на название породы, иногда среди русских голубых кошек встречаются особи с черным и белым окрасом. У типичных же представителей окрас равномерно голубой, с серебристым отливом.
+                        ''',
+
+                    'Саванна':
+                        '''# Саванна
+                           ### Саванна — высокая худая кошка с длинными лапами. Взрослая особь может достигать веса в 15 кг при росте 60 см в холке. Размеры ее тела зависят от близости конкретного представителя к первому скрещенному поколению: чем ближе, тем крупнее животное. Кроме того, под влиянием случайных факторов в генетике породы саванна могут встречаться кошки, значительно отличающиеся по размерам, даже в одном помете. Как правило, саванна имеет пятнистый окрас, но иногда встречаются кошки с мраморным рисунком, снежным окрасом, а также с шерстью голубого или других ненасыщенных цветов. Уши — высокие, с глубокой «чашкой», округленные, прямые (задняя часть уха имеет светлую полосу по центру, с черным, темно-серым или коричневым окаймлением, что создает «эффект глаза»). У этих кошек широкий нос и глаза с нависающими веками. На коротких хвостах — черные кольца и однотонный черный кончик. Глаза могут быть зелеными, коричневыми или золотистыми.
+                        ''',
+
+                    'Шотландская вислоухая':
+                        '''# Шотландская вислоухая
+                           ### Шотла́ндская вислоу́хая ко́шка или ско́ттиш-фолд (англ. Scottish Fold) — порода домашних кошек с характерными загнутыми вперёд и вниз ушами, что вызвано действием доминантного гена, который возник в результате естественной мутации и оказывающий влияние на хрящи во всём организме. Это придаёт голове кошки характерный вид, которую часто описывают как «похожую на совиную».
+                        ''',
+
+                    'Сибирская':
+                        '''# Сибирская
+                           ### Сибирская кошка – прекрасный выбор для семей с детьми и владельцев, которые интересуются разведением и выставочной деятельностью. Ведь порода обладает устойчивой психикой и крепким здоровьем, при этом все еще открыта для сертификации. Разводить «сибиряков» можно даже с беспородной кошкой, обладающей характерными признаками представителей породы. Поэтому привнесение новой крови в племенную линию осуществляется регулярно, и порода не страдает от инбридинга (скрещивания особей, состоящих в тесном родстве).
+                        ''',
+
+                    'Сингапурская':
+                        '''# Сингапурская
+                           ### Сингапурская кошка похожа на маленького представителя абиссинской породы. Ее голова имеет округлую форму с выраженными бакенбардами и короткой широкой мордой. Уши — крупные и глубокие. Глаза — большие, миндалевидной формы, слегка скошенные, широко раскрытые. Несмотря на небольшой размер, тело кошки — коренастое и мускулистое. Хвост — тонкий с тупым кончиком. Шерсть — короткая и гладкая, с черными, коричневыми или кремовыми полосками на каждом из волосков. При этом шерсть имеет более темный окрас на спине, хвосте и ногах, а на груди и животе остается светлой. Глаза у кошек этой породы обычно карие, зеленые или желтые с черным окаймлением.
+                        ''',
+
+                    'Сомалийская':
+                        '''# Сомалийская
+                           ### Сомалийская кошка имеет среднее телосложение. Это крепкое, стройное животное с хорошо развитой мускулатурой и шерстью средней длины. Голова кошки имеет форму клина с мягкими очертаниями. Уши широко посаженные, с кисточками. Имеет глаза миндалевидной формы, часто — янтарного цвета, оттенка грецкого ореха или зеленые. . Взрослая сомалийская кошка имеет «кольцо» шерсти вокруг шеи и пушистые «штанишки», что не выражено у котят. Мягкие, красивые, густые волоски плотно прилегают к телу, при этом каждый из них окрашен как минимум в три цвета. Сомалийская кошка имеет 28 окрасов. Наиболее популярный — насыщенный золотисто-коричневый с кремовой основой и черным тикингом.
+                        ''',
+
+                    'Сфинкс':
+                        '''# Сфинкс
+                           ### Сфинкс – бесшерстная кошка с поведением и характером собаки. Представители породы относятся к классу компаньонов. Поэтому нуждаются во внимании и совсем непохожи на независимых кошек, стремящихся держаться от человека на расстоянии. Животное ориентировано на взаимодействие, любит сидеть на коленях, легко уживается с другими животными в доме и хорошо ладит с детьми, даже самыми маленькими. Порода сфинкс имеет несколько ответвлений. Например, канадский сфинкс, донской сфинкс и петерболд. Однако признание от международных фелинологических организаций заслужил пока лишь канадский.
+                        ''',
+
+                    'Черепаховая':
+                        '''# Черепаховая
+                           ### Черепаховый окрас – один из самых удивительных и необычных окрасов кошек. Черепаховый окрас является очень распространённым среди метисов, а также среди многих пород кошек он закреплён в стандарт��. Вариации цветов полосок и пятен подобного окраса, а также их узоры на шерсти уникальны и неповторимы, так же, как и отпечатки пальцев у людей. Это генетическая особенность, которая передается по наследству и обуславливается определенной комбинацией хромосом.
+                        '''
+                    }

main_app.py

@@ -0,0 +1,84 @@
+import gradio as gr
+import numpy as np
+import requests
+import tensorflow as tf
+from fastapi import FastAPI
+from io import BytesIO
+from PIL import Image
+from pydantic import BaseModel
+from cat_breeds_dict import CAT_BREEDS, CAT_DESCRIPTIONS
+
+
+class Url(BaseModel):
+    link: str
+
+
+MODEL = tf.keras.models.load_model('./models/20_cat_classes_model.h5')
+GRADIO_PATH = '/'
+
+app = FastAPI()
+
+
+def predict(image, api_mode=False):
+    image = image.resize((128, 128))
+    image = np.asarray(image)
+    image = image.reshape(1, 128, 128, 3)
+
+    prediction = MODEL.predict(image)[0]
+    predicted_breed = CAT_BREEDS[np.argmax(prediction)]
+    breed_description = CAT_DESCRIPTIONS[predicted_breed]
+
+    if api_mode:
+        return {'breed': predicted_breed, 'description': breed_description}
+    return {CAT_BREEDS[i]: float(prediction[i]) for i in range(20)}, \
+        breed_description
+
+
+@app.post('/predict_breed/')
+def predict_api(url: Url):
+    try:
+        image = requests.get(url.link).content
+    except:
+        return {'error': 'Invalid link'}
+    image = Image.open(BytesIO(image))
+    return predict(image, api_mode=True)
+
+
+with gr.Blocks(css='./static/style.css') as gradio_ui:
+
+    gr.Markdown(
+        """
+        # Классификатор пород котов
+        Разработано студентами Шершневым А.А, Ивановым С.С, Шалаевой И.Г. и
+        Ильиным С.С.
+        Группы: РИМ-120906, РИМ-120907
+        """,
+        elem_id='md-text'
+    )
+
+    with gr.Row(elem_id='main-row') as row:
+
+        with gr.Column(scale=2, elem_id='first-col') as col_1:
+            user_image = gr.Image(
+                label='Загрузите фотографию котика сюда',
+                type='pil',
+                elem_id='user-image'
+            )
+            predict_button = gr.Button(value='Определить породу')
+
+        with gr.Column(scale=1, elem_id='second-col') as col_2:
+            predicted_labels = gr.Label(
+                num_top_classes=5,
+                label='Результат определения породы',
+                elem_id='predictions-text'
+            )
+
+    breed_description = gr.Markdown(elem_id='breed-description')
+
+    predict_button.click(
+        fn=predict,
+        inputs=[user_image],
+        outputs=[predicted_labels, breed_description]
+    )
+
+    app = gr.mount_gradio_app(app, gradio_ui, path=GRADIO_PATH)

models/20_cat_classes_model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2d143e75db0c7101f3715f606e240250fb6bb2d3bf420def5cac6053b253e739
+size 140809360

requirements.txt

@@ -0,0 +1,5 @@
+numpy==1.23.3
+requests==2.25.1
+tensorflow-cpu==2.10.0
+Pillow==9.0.1
+fastapi==0.88.0

static/style.css

@@ -0,0 +1,45 @@
+#main-row, #breed-description, #md-text {
+    width: 80%;
+    margin: auto;
+}
+
+#predictions-text, #user-image, #first-col{
+    height: 100% !important;
+    max-height: 100% !important;
+    min-height: 100% !important;
+}
+
+#main-row {
+    min-height: 30rem;
+}
+
+#md-text {
+    padding-top: 3%;
+    padding-bottom: 2%;
+}
+
+#breed-description {
+    padding-top: 2%;
+}
+
+.h-60 {
+    height: 30em !important;
+}
+
+@media (min-width: 768px){
+    .md\:min-h-\[15rem\] {
+        min-height: 26rem;
+    }
+}
+
+@media (min-width: 1280px){
+    .xl\:max-h-\[18rem\] {
+    max-height: 30rem;
+    }
+}
+
+@media (min-width: 1536px){
+    .\32xl\:max-h-\[20rem\] {
+        max-height: 30rem;
+    }
+}