add-readme (#15)

- Add README (eb74c3687027cecfca4b172726af9ad77f4cd89d)


Co-authored-by: Pierre Mesure <[email protected]>

app.py

@@ -124,6 +124,12 @@ class ModelConverter:
             self.api.create_repo(output_model_id, exist_ok=True, private=False)
             model_folder_path = self.config.repo_path / "models" / input_model_id
 
+            readme_path = f"{model_folder_path}/README.md"
+
+            if not os.path.exists(readme_path):
+                with open(readme_path, "w") as file:
+                    file.write(self.generate_readme(input_model_id))
+
             self.api.upload_folder(
                 folder_path=str(model_folder_path), repo_id=output_model_id
             )
@@ -135,6 +141,19 @@ class ModelConverter:
 
             shutil.rmtree(model_folder_path, ignore_errors=True)
 
+    def generate_readme(self, imi: str):
+        return (
+            "---\n"
+            "library_name: transformers.js\n"
+            "base_model:\n"
+            f"- {imi}\n"
+            "---\n\n"
+            f"# {imi.split('/')[-1]} (ONNX)\n\n"
+            f"This is an ONNX version of [{imi}](https://huggingface.co/{imi}). "
+            "It was automatically converted and uploaded using "
+            "[this space](https://huggingface.co/spaces/onnx-community/convert-to-onnx).\n"
+        )
+
 
 def main():
     """Main application entry point."""