diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
index 053645d..27b2c7d 100644
--- a/.github/workflows/format.yml
+++ b/.github/workflows/format.yml
@@ -1,6 +1,6 @@
-# Ultralytics 🚀, AGPL-3.0 license
-# Ultralytics Format Workflow
-# This workflow automatically formats code and documentation in pull requests and pushes to main branch
+# Ultralytics 🚀 - AGPL-3.0 license
+# Ultralytics Actions https://github.com/ultralytics/actions
+# This workflow automatically formats code and documentation in PRs to official Ultralytics standards
name: Ultralytics Actions
@@ -14,7 +14,10 @@ jobs:
format:
runs-on: ubuntu-latest
steps:
- - name: Checkout Repository
- uses: actions/checkout@v4
- - name: Run Ultralytics Formatting Actions
+ - name: Run Ultralytics Formatting
uses: ultralytics/actions@main
+ with:
+ python: true
+ docstrings: true
+ markdown: true
+ spelling: true
diff --git a/README.md b/README.md
index 89dcaa6..c4b7dd1 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,13 @@ Currently, we do not provide a public dataset alongside this repository; the met
To run the code in this repository, you will need the following:
- **Python 3.7+**: Install Python and use pip to set up the necessary libraries:
+
```
pip3 install -U -r requirements.txt
```
+
The `requirements.txt` file includes key Python packages such as:
+
- `numpy`
- `scipy`
- `torch` (PyTorch)
@@ -30,14 +33,19 @@ To run the code in this repository, you will need the following:
- `bokeh` (optional, for visualization)
- **MATLAB 2018a or newer**: Besides Python, some scripts require MATLAB. Clone the common functions repository and add it to your MATLAB path with the following commands:
+
```
git clone https://github.com/ultralytics/functions-matlab
```
+
Then in MATLAB:
+
```
>> addpath(genpath('/functions-matlab'))
```
+
Ensure you have the following MATLAB toolboxes installed:
+
- `Statistics and Machine Learning Toolbox`
- `Signal Processing Toolbox`
@@ -46,6 +54,7 @@ To run the code in this repository, you will need the following:
The repository contains various methods for vehicle speed estimation. If you're interested in leveraging these techniques or require more information on running the code, please feel free to reach out.
+
# 📚 Citation
@@ -59,6 +68,7 @@ If our work assists you in your research or project, please consider citing it u
We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 and thank you to all of our contributors!
+