Upload README.md with huggingface_hub

README.md

@@ -1,9 +1,24 @@
----
-tags:
-- model_hub_mixin
-- pytorch_model_hub_mixin
----
-
-This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
-- Library: https://huggingface.co/dthh/test_models
-- Docs: [More Information Needed]
+# SurfaceAI: pipeline for surface type and quality classification of road networks
+
+This repository provides the models weights and parameters for the SurfaceAI pipeline.
+The model version specified in the config file of the pipeline are automatically downloaded from this repo during the execution of the code, if not already available locally.
+
+Find the [paper](https://dl.acm.org/doi/10.1145/3681780.3697277) of this publication and the [code](https://github.com/SurfaceAI/road_network_classification) here.
+
+This is part of the SurfaceAI project at the University of Applied Sciences, HTW Berlin.
+
+
+**Content**: The models are sorted in folders according to version.
+Each version folder contains all models required for the pipeline and, if applicable, documentation of the training parameters.
+The current version is v1.
+
+
+**Contact**: surface-ai@htw-berlin.de
+
+https://surfaceai.github.io/surfaceai/
+
+
+**Citation**: To cite this work, please refer to the [paper](https://dl.acm.org/doi/10.1145/3681780.3697277).
+
+
+**Funding**: SurfaceAI is a mFund project funded by the Federal Ministry for Digital and Transportation Germany.