feat: initial commit

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* 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
+*.ipynb filter=nbstripout

.gitignore

@@ -0,0 +1,5 @@
+results*
+.DS_Store
+.venv
+.jpg
+yolo*.pt

README.md

@@ -1,3 +1,128 @@
----
-license: mit
----
+---
+license: mit
+tags:
+  - yolov5
+  - yolo
+  - vision
+  - object-detection
+  - pytorch
+library_name: yolov5
+datasets:
+  - nakamura196/ndl-layout-dataset
+---
+
+# yolov8-ndl-layout
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+- **Developed by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Model type:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed]
+- **Finetuned from model [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+
+### Direct Use
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+[More Information Needed]
+
+## Training Details
+
+### Training Data
+
+<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+
+[More Information Needed]
+
+### Training Procedure
+
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+
+#### Training Hyperparameters
+
+- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+<!-- This should link to a Dataset Card if possible. -->
+
+[More Information Needed]
+
+#### Factors
+
+<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+
+[More Information Needed]
+
+#### Metrics
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+
+[More Information Needed]
+
+### Results
+
+[More Information Needed]
+
+#### Summary
+
+## Environmental Impact
+
+<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+
+Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
+
+- **Hardware Type:** [More Information Needed]
+- **Hours used:** [More Information Needed]
+- **Cloud Provider:** [More Information Needed]
+- **Compute Region:** [More Information Needed]
+- **Carbon Emitted:** [More Information Needed]
+
+## Model Card Contact
+
+[More Information Needed]

index.ipynb

@@ -0,0 +1,87 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## How tu use\n",
+    "\n",
+    "- Install [ultralyticsplus](https://github.com/fcakyon/ultralyticsplus):\n",
+    "\n",
+    "```bash\n",
+    "pip install -U ultralyticsplus\n",
+    "```\n",
+    "\n",
+    "- Load model and perform prediction:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "Found https://dl.ndl.go.jp/api/iiif/2534020/T0000001/full/full/0/default.jpg locally at default.jpg\n",
+      "image 1/1 /Users/nakamura/git/hf/models/yolov8-ndl-layout/default.jpg: 640x640 1 1_overall, 1 3_typography, 510.9ms\n",
+      "Speed: 2.2ms preprocess, 510.9ms inference, 1.8ms postprocess per image at shape (1, 3, 640, 640)\n"
+     ]
+    }
+   ],
+   "source": [
+    "from ultralyticsplus import YOLO, render_result\n",
+    "import os\n",
+    "\n",
+    "# load model\n",
+    "model = YOLO('model_- 19 may 2024 15_13.pt')\n",
+    "  \n",
+    "# set model parameters\n",
+    "conf_threshold = 0.25  # NMS confidence threshold\n",
+    "iou_threshold = 0.45  # NMS IoU threshold\n",
+    "\n",
+    "# set image\n",
+    "img = 'https://dl.ndl.go.jp/api/iiif/2534020/T0000001/full/full/0/default.jpg'\n",
+    "\n",
+    "# perform inference\n",
+    "results = model.predict(img, conf=conf_threshold, iou=iou_threshold)\n",
+    "render = render_result(model=model, image=img, result=results[0])  \n",
+    "\n",
+    "os.makedirs('results', exist_ok=True)\n",
+    "\n",
+    "# save\n",
+    "render.save('results/1.jpg')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

model_- 19 may 2024 15_13.pt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8acb10e585c68b31142f2f4470606da52ce054ab467368b6bfe22ca547620e12
+size 136737193

requirements.txt

@@ -0,0 +1,2 @@
+ultralyticsplus
+nbstripout