Cleanup (ultralytics#168)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kalen Michael <[email protected]>

.github/translate-readme.yml

@@ -0,0 +1,26 @@
+# Ultralytics YOLO 🚀, GPL-3.0 license
+# README translation action to translate README.md to Chinese as README.zh-CN.md on any change to README.md
+
+name: Translate README
+
+on:
+  push:
+    branches:
+      - translate_readme  # replace with 'main' to enable action
+    paths:
+      - README.md
+
+jobs:
+  Translate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      # ISO Language Codes: https://cloud.google.com/translate/docs/languages
+      - name: Adding README - Chinese Simplified
+        uses: dephraiim/translate-readme@main
+        with:
+          LANG: zh-CN

.github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-# YOLO 🚀 by Ultralytics, GPL-3.0 license
+# Ultralytics YOLO 🚀, GPL-3.0 license
 # YOLO Continuous Integration (CI) GitHub Actions tests
 
 name: Ultralytics CI

.github/workflows/docker.yaml

@@ -1,4 +1,4 @@
-# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+# Ultralytics YOLO 🚀, GPL-3.0 license
 # Builds ultralytics/ultralytics:latest images on DockerHub https://hub.docker.com/r/ultralytics
 
 name: Publish Docker Images

README.md

@@ -68,7 +68,22 @@ pip install ultralytics
 <details open>
 <summary>Usage</summary>
 
-YOLOv8 may be used in a python environment:
+YOLOv8 may be used directly in the Command Line Interface (CLI) with a `yolo` command:
+
+```bash
+yolo task=detect mode=predict model=yolov8n.pt source="https://ultralytics.com/images/bus.jpg"
+```
+
+`yolo` can be used for a variety of tasks and modes and accepts additional arguments, i.e. `imgsz=640`. See a full list of available `yolo` [arguments](https://docs.ultralytics.com/config/) in the YOLOv8 [Docs](https://docs.ultralytics.com).
+
+```bash
+yolo task=detect    mode=train    model=yolov8n.pt        args...
+          classify       predict        yolov8n-cls.yaml  args...
+          segment        val            yolov8n-seg.yaml  args...
+                         export         yolov8n.pt        format=onnx  args...
+```
+
+YOLOv8 may also be used directly in a Python environment, and accepts the same [arguments](https://docs.ultralytics.com/config/) as in the CLI example above:
 
 ```python
 from ultralytics import YOLO
@@ -81,18 +96,16 @@ model.predict(source="https://ultralytics.com/images/bus.jpg")  # predict on an
 model.export(format="onnx")  # export the model to ONNX format
 ```
 
-Or with CLI `yolo` commands:
-
-```bash
-yolo task=detect    mode=train    model=yolov8n.pt        args...
-          classify       predict        yolov8n-cls.yaml  args...
-          segment        val            yolov8n-seg.yaml  args...
-                         export         yolov8n.pt        format=onnx  args...
-```
-
 [Models](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/yolo/v8/models) download automatically from the latest
 Ultralytics [release](https://github.com/ultralytics/ultralytics/releases).
 
+### Known Issues / TODOs
+
+- [ ] TensorFlow exports
+- [ ] GPU exports
+- [ ] DDP resume
+- [ ] [arxiv.org](https://arxiv.org) paper
+
 </details>
 
 ## <div align="center">Checkpoints</div>

docker/Dockerfile

@@ -1,4 +1,4 @@
-# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+# Ultralytics YOLO 🚀, GPL-3.0 license
 # Builds ultralytics/ultralytics:latest image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
 # Image is CUDA-optimized for YOLOv5 single/multi-GPU training and inference
 

docker/Dockerfile-arm64

@@ -1,4 +1,4 @@
-# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+# Ultralytics YOLO 🚀, GPL-3.0 license
 # Builds ultralytics/ultralytics:latest-arm64 image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
 # Image is aarch64-compatible for Apple M1 and other ARM architectures i.e. Jetson Nano and Raspberry Pi
 

docker/Dockerfile-cpu

@@ -1,4 +1,4 @@
-# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+# Ultralytics YOLO 🚀, GPL-3.0 license
 # Builds ultralytics/ultralytics:latest-cpu image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
 # Image is CPU-optimized for ONNX, OpenVINO and PyTorch YOLOv5 deployments
 

requirements.txt

@@ -2,7 +2,6 @@
 # Usage: pip install -r requirements.txt
 
 # Base ----------------------------------------
-fire>=0.4.0
 hydra-core>=1.2.0
 matplotlib>=3.2.2
 numpy>=1.18.5

setup.py

@@ -1,3 +1,5 @@
+# Ultralytics YOLO 🚀, GPL-3.0 license
+
 import re
 from pathlib import Path
 

tests/test_cli.py

@@ -1,3 +1,5 @@
+# Ultralytics YOLO 🚀, GPL-3.0 license
+
 import os
 from pathlib import Path
 

tests/test_engine.py

@@ -1,3 +1,5 @@
+# Ultralytics YOLO 🚀, GPL-3.0 license
+
 from ultralytics import YOLO
 from ultralytics.yolo.configs import get_config
 from ultralytics.yolo.utils import DEFAULT_CONFIG, ROOT

tests/test_python.py

@@ -1,3 +1,5 @@
+# Ultralytics YOLO 🚀, GPL-3.0 license
+
 from pathlib import Path
 
 from ultralytics import YOLO