mlcvzoo-mmdetection

Name	mlcvzoo-mmdetection JSON
Version	6.7.1 JSON
	download
home_page	None
Summary	MLCVZoo MMDetection Package
upload_time	2024-07-10 06:43:42
maintainer	None
docs_url	None
author	Maximilian Otten, email = <maximilian.otten@iml.fraunhofer.de>, Christian Hoppe, email = <christian.hoppe@iml.fraunhofer.de>, Oliver Bredtmann, email = <oliver.bredtmann@dbschenker.com>, Thilo Bauer, email = <thilo.bauer@dbschenker.com>, Oliver Urbann, email = <oliver.urbann@iml.fraunhofer.de>, Jan Basrawi, email = <jan.basrawi@dbschenker.com>, Luise Weickhmann, email = <luise.weickhmann@iml.fraunhofer.de>, Luca Kotulla, email = <luca.kotulla@iml.fraunhofer.de>
requires_python	<4.0,>=3.8
license	Open Logistics Foundation License 1.3
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MLCVZoo MMDetection

The MLCVZoo is an SDK for simplifying the usage of various (machine learning driven)
computer vision algorithms. The package **mlcvzoo_mmdetection** is the wrapper module for
the [mmdetection framework](https://github.com/open-mmlab/mmdetection).

## Install

NOTE: For some panoptic segmentation models of mmdetection you need to have the panopticapi installed.
      How this is handled in mlcvzoo-mmdetection is listed below. Otherwise you will get an ImportError.

### Install for developer

#### Clone repository

```bash
cd YOUR_PATH
git clone git@git.openlogisticsfoundation.org:silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection.git
cd mlcvzoo-mmdetection
```

#### Create and install python environment
```bash
virtualenv .venv
source .venv/bin/activate

# Install dependencies with all extras (including panopticapi)
source build.sh
```

For VSCode IDE add the relevant environment variables in .venv/bin/activate.

```bash
export PYTHONPATH=PARENT_OF_YOUR_REPOSITORY
# The MMDETECTION_DIR is needed in our unit tests for defining the
# path to the configuration files of mmdetection. Since mmdet v2.15.0
# the configuration are stored in the mmdet/.mim/ folder of the installed
# mmdet package in your python environment. For older versions a specific checkout
# is needed.
export MMDETECTION_DIR="$VIRTUAL_ENV/lib/python3.10/site-packages/mmdet/.mim/"
```

## Install for package users

The following command installs the mlcvzoo-mmdetection package, however we
recommend to have a look at the ./build.sh script. It is gathering all fixes
that are needed to setup a running python environment.

```bash
pip install mlcvzoo-mmdetection
```

NOTE: In order to use panoptic segmentations you have to install the following, as specified by mmdetection:

```bash
pip install panopticapi @ git+https://github.com/cocodataset/panopticapi.git@7bb4655548f98f3fedc07bf37e9040a992b054b0
```

# Further documentation
[comment]: <> (TODO: Fix links to main branch)
- [Ar42 Documentation](https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/index.adoc)
- [Installation guide](https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/12_tutorial.adoc#user-content-setup-the-mlcvzoo-models)
- [Configuration Usage](https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/12_tutorial.adoc#user-content-configure-mmdetection)


## Technology stack

- Python

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mlcvzoo-mmdetection",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Maximilian Otten, email =  <maximilian.otten@iml.fraunhofer.de>, Christian Hoppe, email =  <christian.hoppe@iml.fraunhofer.de>, Oliver Bredtmann, email =  <oliver.bredtmann@dbschenker.com>, Thilo Bauer, email =  <thilo.bauer@dbschenker.com>, Oliver Urbann, email =  <oliver.urbann@iml.fraunhofer.de>, Jan Basrawi, email =  <jan.basrawi@dbschenker.com>, Luise Weickhmann, email =  <luise.weickhmann@iml.fraunhofer.de>, Luca Kotulla, email =  <luca.kotulla@iml.fraunhofer.de>",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/bf/60/e5aec7ce6129eed2725c48db7c041d6df99231c5a5f794ed895f4adca8ac/mlcvzoo_mmdetection-6.7.1.tar.gz",
    "platform": null,
    "description": "# MLCVZoo MMDetection\n\nThe MLCVZoo is an SDK for simplifying the usage of various (machine learning driven)\ncomputer vision algorithms. The package **mlcvzoo_mmdetection** is the wrapper module for\nthe [mmdetection framework](https://github.com/open-mmlab/mmdetection).\n\n## Install\n\nNOTE: For some panoptic segmentation models of mmdetection you need to have the panopticapi installed.\n      How this is handled in mlcvzoo-mmdetection is listed below. Otherwise you will get an ImportError.\n\n### Install for developer\n\n#### Clone repository\n\n```bash\ncd YOUR_PATH\ngit clone git@git.openlogisticsfoundation.org:silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection.git\ncd mlcvzoo-mmdetection\n```\n\n#### Create and install python environment\n```bash\nvirtualenv .venv\nsource .venv/bin/activate\n\n# Install dependencies with all extras (including panopticapi)\nsource build.sh\n```\n\nFor VSCode IDE add the relevant environment variables in .venv/bin/activate.\n\n```bash\nexport PYTHONPATH=PARENT_OF_YOUR_REPOSITORY\n# The MMDETECTION_DIR is needed in our unit tests for defining the\n# path to the configuration files of mmdetection. Since mmdet v2.15.0\n# the configuration are stored in the mmdet/.mim/ folder of the installed\n# mmdet package in your python environment. For older versions a specific checkout\n# is needed.\nexport MMDETECTION_DIR=\"$VIRTUAL_ENV/lib/python3.10/site-packages/mmdet/.mim/\"\n```\n\n## Install for package users\n\nThe following command installs the mlcvzoo-mmdetection package, however we\nrecommend to have a look at the ./build.sh script. It is gathering all fixes\nthat are needed to setup a running python environment.\n\n```bash\npip install mlcvzoo-mmdetection\n```\n\nNOTE: In order to use panoptic segmentations you have to install the following, as specified by mmdetection:\n\n```bash\npip install panopticapi @ git+https://github.com/cocodataset/panopticapi.git@7bb4655548f98f3fedc07bf37e9040a992b054b0\n```\n\n# Further documentation\n[comment]: <> (TODO: Fix links to main branch)\n- [Ar42 Documentation](https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/index.adoc)\n- [Installation guide](https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/12_tutorial.adoc#user-content-setup-the-mlcvzoo-models)\n- [Configuration Usage](https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/12_tutorial.adoc#user-content-configure-mmdetection)\n\n\n## Technology stack\n\n- Python\n",
    "bugtrack_url": null,
    "license": "Open Logistics Foundation License 1.3",
    "summary": "MLCVZoo MMDetection Package",
    "version": "6.7.1",
    "project_urls": {
        "documentation": "https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection/-/blob/main/documentation/index.adoc",
        "homepage": "https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection",
        "repository": "https://git.openlogisticsfoundation.org/silicon-economy/base/ml-toolbox/mlcvzoo-models/mlcvzoo-mmdetection"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "313cefc802ee58f057c897f2844ef70397fba3c50a61b6aca15b5a26039fbe2d",
                "md5": "528fe3b3b752e6fc1c7ff8defcf1be79",
                "sha256": "7f51b5dfa38482484a45775645e51e82aefcd43caac0e89a40f570b02b9131e4"
            },
            "downloads": -1,
            "filename": "mlcvzoo_mmdetection-6.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "528fe3b3b752e6fc1c7ff8defcf1be79",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 30412,
            "upload_time": "2024-07-10T06:43:40",
            "upload_time_iso_8601": "2024-07-10T06:43:40.915600Z",
            "url": "https://files.pythonhosted.org/packages/31/3c/efc802ee58f057c897f2844ef70397fba3c50a61b6aca15b5a26039fbe2d/mlcvzoo_mmdetection-6.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf60e5aec7ce6129eed2725c48db7c041d6df99231c5a5f794ed895f4adca8ac",
                "md5": "4d090afb36bfa20fb728249d51c4bede",
                "sha256": "3d6dff57591907212bdb401f2c0234ef45d8bd3340c3673e66a5527b36801726"
            },
            "downloads": -1,
            "filename": "mlcvzoo_mmdetection-6.7.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4d090afb36bfa20fb728249d51c4bede",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 26092,
            "upload_time": "2024-07-10T06:43:42",
            "upload_time_iso_8601": "2024-07-10T06:43:42.717125Z",
            "url": "https://files.pythonhosted.org/packages/bf/60/e5aec7ce6129eed2725c48db7c041d6df99231c5a5f794ed895f4adca8ac/mlcvzoo_mmdetection-6.7.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-10 06:43:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mlcvzoo-mmdetection"
}