Skip to content

Commit

Permalink
Bump to 12.0.3 (#212)
Browse files Browse the repository at this point in the history
* Bump to 12.0.3

* Removed cuda 11.2 from doc
  • Loading branch information
ArchanaShinde1 authored Feb 5, 2024
1 parent cd53b3c commit 0bc8a6a
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[![Installation Options](https://img.shields.io/badge/Install%20with-conda%20%7C%20pip-brightgreen)](#installing-the-open-ce-build-tools)
[![Python Support](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C3.10-blue.svg)](#requirements)
[![Cuda Support](https://img.shields.io/badge/cuda-11.2%20%7C%2011.8%20-blue)](doc/README.cuda_support.md)
[![Cuda Support](https://img.shields.io/badge/cuda-%2011.8%20-blue)](doc/README.cuda_support.md)

[![Builder Unit Tests](https://github.com/open-ce/open-ce/workflows/Open-CE%20Builder%20Unit%20Tests/badge.svg)](https://github.com/open-ce/open-ce-builder/actions?query=workflow%3A%22Open-CE+Builder+Unit+Tests%22+branch%3Amain)
[![Builder Unit Test Coverage](https://codecov.io/gh/open-ce/open-ce-builder/branch/main/graph/badge.svg)](https://codecov.io/gh/open-ce/open-ce-builder)
Expand All @@ -24,7 +24,7 @@ The `open-ce` tool allows a user to build collections of conda recipes described

### Requirements

* `conda`
* `conda`
* The conda tool can either be installed through [Anaconda](https://www.anaconda.com/products/individual#Downloads) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
* `conda-build` >= 3.22
* Once `conda` is installed, `conda-build` can be installed with the command: `conda install conda-build`
Expand All @@ -38,7 +38,7 @@ The `open-ce` tool allows a user to build collections of conda recipes described

### CUDA Requirements

Currently CUDA 11.2 and 11.8 are supported by the recipes in Open-CE. Please see [`doc/README.cuda_support.md`](doc/README.cuda_support.md) for details on setting
Currently CUDA 11.8 are supported by the recipes in Open-CE. Please see [`doc/README.cuda_support.md`](doc/README.cuda_support.md) for details on setting
up a proper build enviornment for CUDA support.

Open-CE expects the `CUDA_HOME` environment variable to be set to the location of the CUDA installation. Note that not all recipes work when `CUDA_HOME` references a non-standard CUDA installation location. Reference the [cuda README](doc/README.cuda_support.md) for more information.
Expand All @@ -47,7 +47,7 @@ When building packages that use CUDA, a tar package of TensorRT for the intended

### Installing the Open-CE Build Tools

To get the Open-CE build tools, one can either install them via `conda` from the [Open-CE channel](https://conda.anaconda.org/open-ce), install them via `pip` from [github](https://github.com/open-ce/open-ce-builder) or clone the source code from [github](https://github.com/open-ce/open-ce-builder) as below -
To get the Open-CE build tools, one can either install them via `conda` from the [Open-CE channel](https://conda.anaconda.org/open-ce), install them via `pip` from [github](https://github.com/open-ce/open-ce-builder) or clone the source code from [github](https://github.com/open-ce/open-ce-builder) as below -

```bash
# Conda install from the open-ce channel
Expand Down
2 changes: 1 addition & 1 deletion conda/recipe/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% set name = "open-ce-builder" %}
{% set version = "12.0.2" %}
{% set version = "12.0.3" %}

package:
name: {{ name }}
Expand Down
12 changes: 6 additions & 6 deletions doc/README.cuda_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ the builds are taking place. This can be accomplished in two ways (see below).
**In all cases, the `CUDA_HOME` environment variable must be set to the base
directory where CUDA has been installed.**

The standard CUDA installation location is in `/usr/local/cuda` which is typically
a symbolic link to either `/usr/local/cuda-11.2` or `/usr/local/cuda-11.8`. Most of
the code bases that are built in Open-CE are flexible enough to tolerate CUDA
installations in non-standard locations, but not all of them. The reference table below
includes the recipes that will not work when CUDA is installed elsewhere.
The standard CUDA installation location is in `/usr/local/cuda` which is typically
a symbolic link to `/usr/local/cuda-11.8`. Most of the code bases that are built in
Open-CE are flexible enough to tolerate CUDA installations in non-standard locations,
but not all of them. The reference table below includes the recipes that will not work
when CUDA is installed elsewhere.

| CUDA_HOME restrictions |
|-----------------|
Expand Down Expand Up @@ -108,7 +108,7 @@ The tag can also be used per line shown in this example for the xgboost [meta.ya
The `--cuda_versions` flag can be passed to `open-ce` to specify which version of CUDA to build conda packages for.
```shell
open-ce build env --build_types cuda --cuda_versions 11.2 envs/opence-env.yaml
open-ce build env --build_types cuda --cuda_versions 11.8 envs/opence-env.yaml
```
Only one CUDA version can be specified at a time. To build for both on the same system, the build must be run twice in one of the following ways:
Expand Down
18 changes: 9 additions & 9 deletions doc/README.open_ce_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Make sure to kill this stale bazel process before retrying the builds.

The `--container_build` option will build an image and run the build command
inside of a container based on the new image. The `--container_tool` option can
be passed to specify container tool to be used.
be passed to specify container tool to be used.

Along with `--container_build` option, `--container_build_args` can be passed
to set container build options like environment variables or other settings
Expand Down Expand Up @@ -153,15 +153,15 @@ optional arguments:
current working directory. (default: )
--python_versions PYTHON_VERSIONS
Comma delimited list of python versions to build for ,
such as "3.8" or "3.9" or "3.10". (default: 3.10 when --build_types=cuda 11.8 or cpu) (default: 3.9 when --build_types=cuda 11.2)
such as "3.8" or "3.9" or "3.10". (default: 3.10 when --build_types=cuda 11.8 or cpu)
--build_types BUILD_TYPES
Comma delimited list of build types, such as "cpu" or
"cuda". (default: cpu,cuda)
--mpi_types MPI_TYPES
Comma delimited list of mpi types, such as "openmpi"
or "system". (default: openmpi)
--cuda_versions CUDA_VERSIONS
CUDA version to build for , such as "11.2" or "11.8".
CUDA version to build for , such as "11.8".
(default: 11.8)
--skip_build_packages
Do not perform builds of packages. (default: False)
Expand Down Expand Up @@ -247,8 +247,8 @@ However, in some cases you may want to just build a selected individual package
from its own feedstock repo. In that case, you can run `open-ce build feedstock`
directly.
Note that a local clone of the desired feedstock repository will need to be present.
By contrast, if you were to use `open-ce build env`, the script will clone any necessary
Note that a local clone of the desired feedstock repository will need to be present.
By contrast, if you were to use `open-ce build env`, the script will clone any necessary
dependency repositories for you.
In addition, note that the `open-ce build feedstock` command should be run from
Expand All @@ -271,7 +271,7 @@ usage: open-ce build feedstock [-h] [--conda_build_configs CONDA_BUILD_CONFIG]
[--local_src_dir LOCAL_SRC_DIR]
[--conda_pkg_format CONDA_PKG_FORMAT]
[--debug DEBUG]
[--debug_output_id DEBUG_OUTPUT_ID]
[--debug_output_id DEBUG_OUTPUT_ID]
[--ppc_arch PPC_ARCH]
optional arguments:
-h, --help show this help message and exit
Expand All @@ -295,7 +295,7 @@ optional arguments:
or "system". (default: openmpi)
--cuda_versions CUDA_VERSIONS
CUDA version to build for ,
such as "11.2" or "11.8". (default: 11.8)
such as "11.8". (default: 11.8)
--recipe-config-file RECIPE_CONFIG_FILE
Path to the recipe configuration YAML file. The configuration
file lists paths to recipes to be built within a feedstock.
Expand Down Expand Up @@ -368,7 +368,7 @@ For example, `opencv` recipe has multiple outputs. If we want to debug just `lib
```

### Complications with feedstocks that have multiple recipes:
Some feedstock repositories in the Open-CE project have more than one recipe included, often containing meta-packages or variant controls as defined in the `config/build-config.yaml` file. When using the `--debug` option on a feedstock with multiple recipes, a debug environment will be created for each included recipe.
Some feedstock repositories in the Open-CE project have more than one recipe included, often containing meta-packages or variant controls as defined in the `config/build-config.yaml` file. When using the `--debug` option on a feedstock with multiple recipes, a debug environment will be created for each included recipe.
One further complication occurs when a feedstock includes multiple recipes, and one of them contains multiple outputs. In this case, since the `--debug_output_id` option is required and it would subsequently be passed to each included recipe in the feedstock, it's best to use the `--recipes` option to only choose the recipe desired to debug.
## `open-ce build image` sub command
Expand All @@ -378,7 +378,7 @@ packages (generated from `open-ce build env`) installed in it. This script takes
as an input - local conda channel and conda environment file which are the output of `open-ce build env`
script.
The `--container_tool` option can be passed to specify container tool to be used. Additionally
The `--container_tool` option can be passed to specify container tool to be used. Additionally
`--container_build_args` can be passed to set container build options like environment variables
or other settings like cpusets.
Expand Down
4 changes: 2 additions & 2 deletions doc/README.open_ce_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,15 @@ optional arguments:
current working directory. (default: )
--python_versions PYTHON_VERSIONS
Comma delimited list of python versions to build for ,
such as "3.8" or "3.9" or "3.10". (default: 3.10 when --build_types=cuda 11.8 or cpu) (default: 3.9 when --build_types=cuda 11.2) 
such as "3.8" or "3.9" or "3.10". (default: 3.10 when --build_types=cuda 11.8 or cpu) 
--build_types BUILD_TYPES
Comma delimited list of build types, such as "cpu" or
"cuda". (default: cpu,cuda)
--mpi_types MPI_TYPES
Comma delimited list of mpi types, such as "openmpi"
or "system". (default: openmpi)
--cuda_versions CUDA_VERSIONS
CUDA version to build for , such as "11.2" or "11.8".
CUDA version to build for , such as "11.8".
(default: 11.8)
--container_build, --docker_build
Perform a build within a container. NOTE: When
Expand Down
2 changes: 1 addition & 1 deletion open_ce/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
# limitations under the License.
# *****************************************************************
"""
__version__ = "12.0.2"
__version__ = "12.0.3"
2 changes: 1 addition & 1 deletion open_ce/inputs.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ class Argument(Enum):
type=str,
default=constants.DEFAULT_CUDA_VERS,
help='CUDA version to build for '
', such as "11.2" or "11.8".'))
', such as "11.8".'))

CONTAINER_BUILD = (lambda parser: parser.add_argument(
'--container_build',
Expand Down

0 comments on commit 0bc8a6a

Please sign in to comment.