3 Star 0 Fork 0

mirrors_BMW-InnovationLab / BMW-TensorFlow-Training-GUI

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Tensorflow 2 Object Detection Training GUI for Linux

Updated for CUDA 11 and Tensorflow 2!!!

This repository allows you to get started with training a State-of-the-art Deep Learning model with little to no configuration needed! You provide your labeled dataset and you can start the training right away and monitor it with TensorBoard. You can even test your model with our built-in Inference REST API. Training with TensorFlow has never been so easy.

You can also use our BMW-Labeltool-lite to label your dataset. The images and labels can be used directly for training.

  • This repository is based on Tensorflow Object Detection API
  • The tensorflow version used is in this repo is 2.5.0
  • All supported networks in this project are taken from the tensorflow model zoo
  • All training are made using pre-trained network weights.
  • The pre-trained weights that you can use out of the box are based on the COCO dataset.
  • The app was tested with Google Chrome and it is recommended to use Chrome when training.
  • This repository support training on both CPU and on multiple GPU (up to 2 GPUs)

Prerequisites

  • Ubuntu 18.04
  • NVIDIA Drivers (418.x or higher)
  • Docker CE latest stable release
  • NVIDIA Docker 2
  • Docker-Compose

Setting Up Project Requirements Automated

This step is recommended to be able to run the solution correctly.

The setup script will check and adjust all the requirements needed based on the user input.

  • Run the following command

    chmod +x setup_solution_parameters.sh && source setup_solution_parameters.sh

    • The script will check if docker and docker-compose are installed and if not, it will install them.

    • You will be prompted to choose build architecture GPU/CPU for the training solution.

      • If you chose GPU the script will check if nvidia-docker is installed and if not, it will install it.
    • The script will prompt all the network interfaces that are available so you can select which interface you want to extract the ip address from it

    • You will be prompted to choose if you want to set up a proxy

    • You will be prompted to select all the pre-trained weights network that you want to be downloaded during the docker image build (use the up/down arrow to go up and down, space to select/unselect, enter to submit your selection and esc to quit)

Setting Up Project Requirements Manually

How to check for prerequisites

To check if you have docker-ce installed:

docker --version

To check if you have docker-compose installed:

docker-compose --version

To check if you have nvidia-docker installed:

dpkg -l | grep nvidia-docker

To check your nvidia drivers version, open your terminal and type the command nvidia-smi

Installing Prerequisites

  • If you don't have neither docker nor docker-compose use the following command

    chmod +x install_full.sh && source install_full.sh

  • If you have docker ce installed and wish only to install docker-compose and perform necessary operations, use the following command

    chmod +x install_compose.sh && source install_compose.sh

  • Install NVIDIA Drivers (418.x or higher) and NVIDIA Docker for GPU training by following the official docs

  • Make sure that the .gitkeep files in datasets, checkpoints, tensorboards and inference_api/models folder are deleted. (.gitkeep files are placeholder files used for git)

  • Make sure that the base_dir field in docker_sdk_api/assets/paths.json is correct (it must match the path of the root of the repo on your machine).

  • Make sure that the image_name field in docker_sdk_api/assets/paths.json is correct (it must match your chosen architecture for the training tf2_training_api_cpu or tf2_training_api_gpu).

  • Go to gui/src/environments/environment.ts and gui/src/environments/environment.prod.ts and change the following:

    • field url: must match the IP address of your machine

    • the IP field of the inferenceAPIUrl : must match the IP address of your machine (Use the ifconfig command to check your IP address . Please use your private IP which starts by either 10. or 172.16. or 192.168.)

      "environment.ts"
      environment.ts

      "environment.prod.ts"
      environment.prod.ts

If you are behind a proxy:

  • Enter you proxy settings in the <base-dir>/proxy.json file

  • Enter the following command:

      python3 set_proxy_args.py

Dataset Folder Structure

The following is an example of how a dataset should be structured. Please put all your datasets in the datasets folder.

├──datasets/
    ├──sample_dataset/
        ├── images
        │   ├── img_1.jpg
        │   └── img_2.jpg
        ├── labels
        │   ├── json
        │   │   ├── img_1.json
        │   │   └── img_2.json
        │   └── pascal
        │       ├── img_1.xml
        │       └── img_2.xml
        └── objectclasses.json

PS: you don't need to have both json and pascal folders. Either one is enough

  • If you want to label your images, you can use our BMW-LabelTool-Lite which is a free, open-source image annotation tool. This tool supports our JSON label format

Objectclasses.json file example

You must include in your dataset an objectclasses.json file with a similar structure to the example below:

Midweight and Heavyweight Solution

Midweight: Downloading specific supported online pre-trained weights during the docker image build.
To do that, open the json file training_api/assets/networks.json and change the values of the networks you wish to download to true.

Heavyweight (default): Downloading all the supported online pre-trained weights during the docker image build.
To do that, open the json file training_api/assets/networks.json and change the value of "select_all" to true.

PS: if you don’t download the weights during the build, you won’t be able to use the network during the training unless you rebuild the solution with the proper network chosen.

All the training are made using the pre-trained network weight based on coco dataset.

Build the Solution

If you wish want to deploy the training workflow in GPU mode, please write the following command from the repository's root directory

docker-compose -f build_gpu.yml build

If you wish want to deploy the training workflow in CPU mode, please write the following command from the repository's root directory

docker-compose -f build_cpu.yml build 

Run the Solution

If you wish want to deploy the training workflow in GPU mode, please write the following command

docker-compose -f run_gpu.yml up

If you wish to deploy the training workflow in CPU mode, please write the following command

docker-compose -f run_cpu.yml up

After a successful run you should see something like the following:

Usage

  • If the app is deployed on your machine: open your web browser and type the following: localhost:4200 or 127.0.0.1:4200

  • If the app is deployed on a different machine: open your web browser and type the following: <machine_ip>:4200

1- Preparing Dataset

Prepare your dataset for training


2- Specifying General Settings

Specify the general parameters for you docker container


3- Specifying Hyperparameters

Specify the hyperparameters for the training job


4- Specifying Hyperparameters advanced

Specify the advanced hyperparameters for the training job


5- Checking training logs

Check your training logs to get better insights on the progress of the training


6- Monitoring the training

Monitor the training using Tensorboard


7- Checking the status of the job

Check the status to know when the job is completed successfully


8- Downloading and test with Swagger

Download your mode and easily test it with the built-in inference API using Swagger


9- Stopping and Delete the model's container

Delete the container's job to stop an ongoing job or to remove the container of a finished job. (Finished jobs are always available to download)


10- Visualizing graphs and metrics of Deleted Jobs

Visualize graphs and metrics of Deleted Jobs with Tensorboard


Training and Tensorboard Tips

Check our tips document to have (1) (a better insight on training models based on our expertise) and (2) (a benchmark of the inference speed).

Our tensorboard document helps you find your way more easily while navigating tensorboard

Guidelines

  • In advanced configuration mode, be careful while making the changes because it can cause errors while training. If that happens, stop the job and try again.

    • the paths in fine_tune_checkpoint should be entered manually when you choose train from checkpoint

    • Scroll down to find fine_tune_checkpoint and replace with your network-name and checkpoint name:

      • fine_tune_checkpoint :

        fine_tune_checkpoint: "/checkpoints/<network-name>/<name-of-the-checkpoint>/ckpt-0"

  • In general settings, choose carefully the container name because choosing a name used by another container will cause errors.

  • When you try to monitor the job using tensorboard the page may not open, wait for some seconds and refresh the page.

  • When you leave tensorboard open for a long time, it might freeze. When encountered with such issue simply closing tensorboard tab in the browser and reopening it will solve the problem.



Change Docker-sdk default port

To change the docker-sdk default port 2222 to any other port of your choice:

  • change the uvicorn port inside docker_sdk_api/docker/Dockerfile to the port of your choice

  • rebuild the docker-sdk image using the following commend in the root of the repo:

    • docker-compose -f build.yml build docker_sdk
  • change the baseEndPoint : <port-of-your-choice inside gui/src/environments/environment.ts and gui/src/environments/environment.prod.ts

  • rebuild the GUI image using the following comment in the root of the repo:

    • docker-compose -f build.yml build user_interface
  • after this you can run the solution as following: docker-compose -f run.yml up



Know Issues

You might face some errors in some cases during the training. Most common ones are:

  • The running container has no RepoTag please kill to proceed: Container ID: <id-container> This issue is caused by some container not having a name, in that case you should rename that container or kill (make sure it is safe to remove this container) it via docker kill <id-container>.
  • Job Not Started: 404 Client Error Not Found("pull access denied for <image-name>, repository does not exists or may require 'docker login' ...) this issue is cause when you are trying to run a training docker image that you don't have. The main reason of this is not properly building the training_api or not setting up project requirements please refer to Setting Up Project Requirements section in the documentation.
  • Dataset Not Valid this error means that you dataset structure is not valid or the images/labels formate are not supported.
  • Training job not started after general settings step: One of the main reason is that the paths are not adjusted in docker_sdk_api/assets/paths.json field base_dir. You can solve this issue by running ./setup_solution_parameters.sh and choosing the training version you want to use GPU/CPU.

Citing

If you use this repository in your research, consider citing it using the following Bibtex entry:

@misc{bmwtrainingtool,
  author = {BMW TechOffice MUNICH},
  title = {TensorFlow Training GUI},
  howpublished = {\url{https://github.com/BMW-InnovationLab/BMW-TensorFlow-Training-GUI}},
  year = {2022},
}

Acknowledgments

  • Hadi Koubeissy, inmind.ai, Beirut, Lebanon

  • Ismail Shehab, inmind.ai, Beirut, Lebanon

  • Joe Sleiman, inmind.ai, Beirut, Lebanon

  • Jimmy Tekli, BMW Innovation Lab, Munich, Germany

  • Chafic Abou Akar, BMW TechOffice, Munich, Germany

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/mirrors_BMW-InnovationLab/BMW-TensorFlow-Training-GUI.git
git@gitee.com:mirrors_BMW-InnovationLab/BMW-TensorFlow-Training-GUI.git
mirrors_BMW-InnovationLab
BMW-TensorFlow-Training-GUI
BMW-TensorFlow-Training-GUI
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891