Commit af693c41 authored by Cresson Remi's avatar Cresson Remi
Browse files

Merge branch '47-prepare_release_4.2.0' into 'develop'

Release 4.2.0

Closes #47

See merge request !98
2 merge requests!99Release 4.2.0,!98Release 4.2.0
Pipeline #49834 passed with stages
in 12 minutes and 6 seconds
Showing with 36 additions and 24 deletions
+36 -24
variables: variables:
OTBTF_VERSION: 4.1.0 OTBTF_VERSION: 4.2.0
OTB_BUILD: /src/otb/build/OTB/build # Local OTB build directory OTB_BUILD: /src/otb/build/OTB/build # Local OTB build directory
OTBTF_SRC: /src/otbtf # Local OTBTF source directory OTBTF_SRC: /src/otbtf # Local OTBTF source directory
OTB_TEST_DIR: $OTB_BUILD/Testing/Temporary # OTB testing directory OTB_TEST_DIR: $OTB_BUILD/Testing/Temporary # OTB testing directory
......
...@@ -33,8 +33,8 @@ The documentation is available on [otbtf.readthedocs.io](https://otbtf.readthedo ...@@ -33,8 +33,8 @@ The documentation is available on [otbtf.readthedocs.io](https://otbtf.readthedo
You can use our latest GPU enabled docker images. You can use our latest GPU enabled docker images.
```bash ```bash
docker run --runtime=nvidia -ti mdl4eo/otbtf:4.1.0-gpu otbcli_PatchesExtraction docker run --runtime=nvidia -ti mdl4eo/otbtf:4.2.0-gpu otbcli_PatchesExtraction
docker run --runtime=nvidia -ti mdl4eo/otbtf:4.1.0-gpu python -c "import otbtf" docker run --runtime=nvidia -ti mdl4eo/otbtf:4.2.0-gpu python -c "import otbtf"
``` ```
You can also build OTBTF from sources (see the documentation) You can also build OTBTF from sources (see the documentation)
......
Version 4.2.0 (12 sep 2023)
----------------------------------------------------------------
* Add new python modules: `otbtf.layers` (with new classes `DilatedMask`, `ApplyMask`, `ScalarsTile`, `ArgMax`, `Max`) and `otbtf.ops` (`one_hot()`)
* Fix an error in the documentation
* Update the otbtf-keras tutorial
* Add decloud testing in CI
* Fix protobuf version in dockerfile (see https://github.com/tensorflow/tensorflow/issues/61551)
Version 4.1.0 (23 may 2023) Version 4.1.0 (23 may 2023)
---------------------------------------------------------------- ----------------------------------------------------------------
* Add no-data values support for inference in TensorflowModelServe application * Add no-data values support for inference in TensorflowModelServe application
......
...@@ -52,13 +52,13 @@ sudo service docker {status,enable,disable,start,stop,restart} ...@@ -52,13 +52,13 @@ sudo service docker {status,enable,disable,start,stop,restart}
Run a simple command in a one-shot container: Run a simple command in a one-shot container:
```bash ```bash
docker run mdl4eo/otbtf:3.4.0-cpu otbcli_PatchesExtraction docker run mdl4eo/otbtf:4.2.0-cpu otbcli_PatchesExtraction
``` ```
You can also use the image in interactive mode with bash: You can also use the image in interactive mode with bash:
```bash ```bash
docker run -ti mdl4eo/otbtf:3.4.0-cpu bash docker run -ti mdl4eo/otbtf:4.2.0-cpu bash
``` ```
### Mounting file systems ### Mounting file systems
...@@ -70,7 +70,7 @@ to use inside the container: ...@@ -70,7 +70,7 @@ to use inside the container:
The following command shows you how to access the folder from the docker image. The following command shows you how to access the folder from the docker image.
```bash ```bash
docker run -v /mnt/disk1/:/data/ -ti mdl4eo/otbtf:3.4.0-cpu bash -c "ls /data" docker run -v /mnt/disk1/:/data/ -ti mdl4eo/otbtf:4.2.0-cpu bash -c "ls /data"
``` ```
Beware of ownership issues! see the last section of this doc. Beware of ownership issues! see the last section of this doc.
...@@ -81,7 +81,7 @@ any directory. ...@@ -81,7 +81,7 @@ any directory.
```bash ```bash
docker create --interactive --tty --volume /home/$USER:/home/otbuser/ \ docker create --interactive --tty --volume /home/$USER:/home/otbuser/ \
--name otbtf mdl4eo/otbtf:3.4.0-cpu /bin/bash --name otbtf mdl4eo/otbtf:4.2.0-cpu /bin/bash
``` ```
!!! warning !!! warning
...@@ -160,7 +160,7 @@ automatically pull image ...@@ -160,7 +160,7 @@ automatically pull image
```bash ```bash
docker create --interactive --tty --volume /home/$USER:/home/otbuser \ docker create --interactive --tty --volume /home/$USER:/home/otbuser \
--name otbtf mdl4eo/otbtf:3.4.0-cpu /bin/bash --name otbtf mdl4eo/otbtf:4.2.0-cpu /bin/bash
``` ```
Start a background container process: Start a background container process:
......
...@@ -5,13 +5,13 @@ We recommend to use OTBTF from official docker images. ...@@ -5,13 +5,13 @@ We recommend to use OTBTF from official docker images.
Latest CPU-only docker image: Latest CPU-only docker image:
```commandline ```commandline
docker pull mdl4eo/otbtf:4.1.0-cpu docker pull mdl4eo/otbtf:4.2.0-cpu
``` ```
Latest GPU-ready docker image: Latest GPU-ready docker image:
```commandline ```commandline
docker pull mdl4eo/otbtf:4.1.0-gpu docker pull mdl4eo/otbtf:4.2.0-gpu
``` ```
Read more in the following sections. Read more in the following sections.
...@@ -25,12 +25,12 @@ Since OTBTF >= 3.2.1 you can find the latest docker images on ...@@ -25,12 +25,12 @@ Since OTBTF >= 3.2.1 you can find the latest docker images on
| Name | Os | TF | OTB | Description | Dev files | Compute capability | | Name | Os | TF | OTB | Description | Dev files | Compute capability |
|------------------------------------------------------------------------------------| ------------- |-------|-------| ---------------------- | --------- | ------------------ | |------------------------------------------------------------------------------------| ------------- |-------|-------| ---------------------- | --------- | ------------------ |
| **mdl4eo/otbtf:4.1.0-cpu** | Ubuntu Jammy | r2.12 | 8.1.0 | CPU, no optimization | no | 5.2,6.1,7.0,7.5,8.6| | **mdl4eo/otbtf:4.2.0-cpu** | Ubuntu Jammy | r2.12 | 8.1.0 | CPU, no optimization | no | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-cpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | CPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6| | **mdl4eo/otbtf:4.2.0-cpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | CPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-gpu** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization | no | 5.2,6.1,7.0,7.5,8.6| | **mdl4eo/otbtf:4.2.0-gpu** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization | no | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-gpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6| | **mdl4eo/otbtf:4.2.0-gpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
| **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.1.0-gpu-opt** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. | no | 5.2,6.1,7.0,7.5,8.6| | **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.2.0-gpu-opt** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. | no | 5.2,6.1,7.0,7.5,8.6|
| **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.1.0-gpu-opt-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. (dev) | yes | 5.2,6.1,7.0,7.5,8.6| | **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.2.0-gpu-opt-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
The list of older releases is available [here](#older-images). The list of older releases is available [here](#older-images).
...@@ -51,13 +51,13 @@ You can then use the OTBTF `gpu` tagged docker images with the **NVIDIA runtime* ...@@ -51,13 +51,13 @@ You can then use the OTBTF `gpu` tagged docker images with the **NVIDIA runtime*
With Docker version earlier than 19.03 : With Docker version earlier than 19.03 :
```bash ```bash
docker run --runtime=nvidia -ti mdl4eo/otbtf:4.1.0-gpu bash docker run --runtime=nvidia -ti mdl4eo/otbtf:4.2.0-gpu bash
``` ```
With Docker version including and after 19.03 : With Docker version including and after 19.03 :
```bash ```bash
docker run --gpus all -ti mdl4eo/otbtf:4.1.0-gpu bash docker run --gpus all -ti mdl4eo/otbtf:4.2.0-gpu bash
``` ```
You can find some details on the **GPU docker image** and some **docker tips You can find some details on the **GPU docker image** and some **docker tips
...@@ -80,7 +80,7 @@ See here how to install docker on Ubuntu ...@@ -80,7 +80,7 @@ See here how to install docker on Ubuntu
1. Install [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10#manual-installation-steps) (Windows Subsystem for Linux) 1. Install [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10#manual-installation-steps) (Windows Subsystem for Linux)
2. Install [docker desktop](https://www.docker.com/products/docker-desktop) 2. Install [docker desktop](https://www.docker.com/products/docker-desktop)
3. Start **docker desktop** and **enable WSL2** from *Settings* > *General* then tick the box *Use the WSL2 based engine* 3. Start **docker desktop** and **enable WSL2** from *Settings* > *General* then tick the box *Use the WSL2 based engine*
3. Open a **cmd.exe** or **PowerShell** terminal, and type `docker create --name otbtf-cpu --interactive --tty mdl4eo/otbtf:4.1.0-cpu` 3. Open a **cmd.exe** or **PowerShell** terminal, and type `docker create --name otbtf-cpu --interactive --tty mdl4eo/otbtf:4.2.0-cpu`
4. Open **docker desktop**, and check that the docker is running in the **Container/Apps** menu 4. Open **docker desktop**, and check that the docker is running in the **Container/Apps** menu
![Docker desktop, after the docker image is downloaded and ready to use](images/docker_desktop_1.jpeg) ![Docker desktop, after the docker image is downloaded and ready to use](images/docker_desktop_1.jpeg)
5. From **docker desktop**, click on the icon highlighted as shown below, and use the bash terminal that should pop up! 5. From **docker desktop**, click on the icon highlighted as shown below, and use the bash terminal that should pop up!
...@@ -166,4 +166,10 @@ Here you can find the list of older releases of OTBTF: ...@@ -166,4 +166,10 @@ Here you can find the list of older releases of OTBTF:
| **mdl4eo/otbtf:4.0.0-gpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6| | **mdl4eo/otbtf:4.0.0-gpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
| **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.0.0-gpu-opt** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. | no | 5.2,6.1,7.0,7.5,8.6| | **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.0.0-gpu-opt** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. | no | 5.2,6.1,7.0,7.5,8.6|
| **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.0.0-gpu-opt-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. (dev) | yes | 5.2,6.1,7.0,7.5,8.6| | **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.0.0-gpu-opt-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-cpu** | Ubuntu Jammy | r2.12 | 8.1.0 | CPU, no optimization | no | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-cpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | CPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-gpu** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization | no | 5.2,6.1,7.0,7.5,8.6|
| **mdl4eo/otbtf:4.1.0-gpu-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU, no optimization (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
| **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.1.0-gpu-opt** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. | no | 5.2,6.1,7.0,7.5,8.6|
| **gitlab.irstea.fr/remi.cresson/otbtf/container_registry/otbtf:4.1.0-gpu-opt-dev** | Ubuntu Jammy | r2.12 | 8.1.0 | GPU with opt. (dev) | yes | 5.2,6.1,7.0,7.5,8.6|
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
# ========================================================================== # ==========================================================================
# #
# Copyright 2018-2019 IRSTEA # Copyright 2018-2019 IRSTEA
# Copyright 2020-2022 INRAE # Copyright 2020-2023 INRAE
# #
# Licensed under the Apache License, Version 2.0 (the "License"); # Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License. # you may not use this file except in compliance with the License.
......
...@@ -6,7 +6,7 @@ with open("README.md", "r", encoding="utf-8") as fh: ...@@ -6,7 +6,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
setuptools.setup( setuptools.setup(
name="otbtf", name="otbtf",
version="4.1.0", version="4.2.0",
author="Remi Cresson", author="Remi Cresson",
author_email="remi.cresson@inrae.fr", author_email="remi.cresson@inrae.fr",
description="OTBTF: Orfeo ToolBox meets TensorFlow", description="OTBTF: Orfeo ToolBox meets TensorFlow",
...@@ -14,11 +14,9 @@ setuptools.setup( ...@@ -14,11 +14,9 @@ setuptools.setup(
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
url="https://gitlab.irstea.fr/remi.cresson/otbtf", url="https://gitlab.irstea.fr/remi.cresson/otbtf",
classifiers=[ classifiers=[
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Topic :: Scientific/Engineering :: GIS", "Topic :: Scientific/Engineering :: GIS",
"Topic :: Scientific/Engineering :: Image Processing", "Topic :: Scientific/Engineering :: Image Processing",
"License :: OSI Approved :: Apache Software License", "License :: OSI Approved :: Apache Software License",
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment