Metadata-Version: 2.1
Name: hx-odmetrics
Version: 0.1.5
Summary: Multi-object Tracking (MOT) for perceptionn OD(Obstacle Detection), used for overall evaluation of E2E Tracking system.
Author: Haokun Zhang
Author-email: haokun.zhang@hirain.com
License: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

[![PyPI version](https://badge.fury.io/py/hx-odmetrics.svg)](https://pypi.org/project/hx-odmetrics/) 

# hx-odmetrics 评测工具

## 版本发布与迭代
* 版本上线 0.1.1 (2024-06-04)
* 版本简要：
1. 简化了指令，无需指定gt的路径，只需要指定模型输出.record的路径即可
2. 修复了由于内部路径读取错误而在运行时抛出`FileNotFoundError`


* 使用方法: 暂时同步到飞书文档中 [多目标跟踪评测工具: OD](https://zvnz49xxfzh.feishu.cn/docx/LiatdZ9kHojAXuxXP10cD9m8nse?from=from_copylink)


## 安装方式 
via PyPI
```bash
# 直接安装
pip install --trusted-host 218.98.160.70 \
    --extra-index-url http://218.98.160.70:30722/simple \
    hx-odmetrics

# alternative image source 安装
pip install --trusted-host 218.98.160.70 \
    --extra-index-url http://218.98.160.70:30722/simple \
    hx-odmetrics -U -i https://pypi.tuna.tsinghua.edu.cn/simple
```

### 安装时问题：
* 跳出警告(ERROR):
```
ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cyber-record 0.1.12 requires protobuf<=3.19.4; python_version >= "3.7", but you have protobuf 3.20.3 which is incompatible.
```
这是由于`cyber-record`要求`protobuf`的版本小于等于3.19.4，(而现在的protobuf版本major已经达到了5)，这可能会在您的安装过程中过处错误，然而更高的版本仍然不会与`cyber-record`冲突，这也不会在您使用的过程中造成影响(除非您的环境中有其他的第三方库对`protobuf`有着不一样的要求)，因此请暂时忽略。

# 开发人员
[Haokun Zhang](haokun.zhang@hirain.com)

# License
```plain text
Multi-object Tracking (MOT) for perceptionn OD(Obstacle Detection), used for overall evaluation of
E2E Tracking system.
Copyright (C) 2024  Haokun Zhang

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```
