[ADD] Random Guessr

.gitignore

@@ -0,0 +1,164 @@
+# 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/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Perso
+data/
+models/

README.md

@@ -1,12 +1,3 @@
----
-title: Geoguessr Bot
-emoji: 👀
-colorFrom: pink
-colorTo: indigo
-sdk: gradio
-sdk_version: 3.28.1
-app_file: app.py
-pinned: false
----
+# Geoguessr bot
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+A bot playing Geoguessr using Computer Vision models. WIP... :wrench:

app.py

@@ -0,0 +1,60 @@
+import numpy as np
+import gradio as gr
+import plotly.graph_objects as go
+
+from geoguessr_bot.guessr import RandomGuessr, AbstractGuessr
+
+ALL_GUESSR_CLASS = {
+    "random": RandomGuessr
+}
+
+ALL_GUESSR_ARGS = {
+    "random": {}
+}
+
+# For instantiating guessrs only when needed
+ALL_GUESSR = {}
+
+
+def create_map(guessr: str) -> go.Figure:
+    """Create an interactive map
+    """
+    # Instantiate guessr if not already done
+    if guessr not in ALL_GUESSR:
+        ALL_GUESSR[guessr] = ALL_GUESSR_CLASS[guessr](**ALL_GUESSR_ARGS[guessr])
+    return AbstractGuessr.create_map()
+
+
+def guess(guessr: str, uploaded_image) -> go.Figure:
+    """Guess a coordinate from an image uploaded in the Gradio interface
+    """
+    # Instantiate guessr if not already done
+    if guessr not in ALL_GUESSR:
+        ALL_GUESSR[guessr] = ALL_GUESSR_CLASS[guessr](**ALL_GUESSR_ARGS[guessr])
+    # Convert image to numpy array
+    uploaded_image = np.array(uploaded_image)
+    # Guess coordinate
+    guess_coordinate = ALL_GUESSR[guessr].guess(uploaded_image)
+    # Create map
+    fig = ALL_GUESSR[guessr].create_map(guess_coordinate)
+    return fig
+
+
+if __name__ == "__main__":
+    # Create & launch Gradio interface
+    with gr.Blocks() as demo:
+        with gr.Row():
+            with gr.Column():
+                guessr_dropdown = gr.Dropdown(
+                    list(ALL_GUESSR_CLASS.keys()),
+                    value="random",
+                    label="Guessr type",
+                    info="More Guessr types will be added soon!"
+                )
+                image = gr.Image(shape=(800, 800))
+                button = gr.Button(text="Guess")
+            interactive_map = gr.Plot()
+            demo.load(create_map, [guessr_dropdown], interactive_map)
+            button.click(guess, [guessr_dropdown, image], interactive_map)
+    # Launch demo 🚀
+    demo.launch()

geoguessr_bot/guessr/__init__.py

@@ -0,0 +1,2 @@
+from .abstract_guessr import AbstractGuessr
+from .random_guessr import RandomGuessr

geoguessr_bot/guessr/abstract_guessr.py

@@ -0,0 +1,51 @@
+from abc import abstractmethod
+from dataclasses import dataclass
+from typing import Optional
+
+from PIL import Image
+import plotly.graph_objects as go
+
+from geoguessr_bot.interfaces import Coordinate
+
+
+@dataclass
+class AbstractGuessr:
+    """Abstract class for a guessr
+    """
+    @abstractmethod
+    def guess(self, image: Image) -> Coordinate:
+        raise NotImplementedError
+
+    def guess_from_path(self, image_path: str) -> Coordinate:
+        image = Image.open(image_path)
+        return self.guess(image)
+
+    @staticmethod
+    def create_map(guess_coordinate: Optional[Coordinate] = None, **kwargs) -> go.Figure:
+        """Create an interactive map showing a coordinate
+        """
+        fig = go.Figure(go.Scattermapbox(
+            customdata=[guess_coordinate.__str__()] if guess_coordinate is not None else None,
+            lat=[guess_coordinate.latitude] if guess_coordinate is not None else None,
+            lon=[guess_coordinate.longitude] if guess_coordinate is not None else None,
+            mode="markers",
+            marker=go.scattermapbox.Marker(
+                size=6,
+            ),
+            hoverinfo="text",
+            hovertemplate='coord: %{customdata[0]}'
+        ))
+        fig.update_layout(
+            mapbox_style="open-street-map",
+            hovermode='closest',
+            mapbox=dict(
+                bearing=0,
+                center=go.layout.mapbox.Center(
+                    lat=guess_coordinate.latitude if guess_coordinate is not None else 0,
+                    lon=guess_coordinate.longitude if guess_coordinate is not None else 0
+                ),
+                pitch=0,
+                zoom=3 if guess_coordinate is not None else 0
+            ),
+        )
+        return fig

geoguessr_bot/guessr/random_guessr.py

@@ -0,0 +1,19 @@
+import numpy as np
+from PIL import Image
+
+from .abstract_guessr import AbstractGuessr
+from ..interfaces import Coordinate
+
+
+class RandomGuessr(AbstractGuessr):
+    """Guesses a random coordinate
+    """
+    @staticmethod
+    def _random_coordinate() -> Coordinate:
+        return Coordinate(
+            latitude=np.random.uniform(-90, 90),
+            longitude=np.random.uniform(-180, 180)
+        )
+
+    def guess(self, image: Image) -> Coordinate:
+        return self._random_coordinate()

geoguessr_bot/interfaces.py

@@ -0,0 +1,9 @@
+from pydantic.main import BaseModel
+
+
+class Coordinate(BaseModel):
+    latitude: float
+    longitude: float
+
+    def __str__(self):
+        return f"({round(self.latitude, 6)}, {round(self.longitude, 6)})"