Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated readme for issue# 324 and some miscellaneous changes #151

Merged
merged 5 commits into from
Oct 13, 2022
Merged

Updated readme for issue# 324 and some miscellaneous changes #151

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fcd521b
Updated readme for issue# 324
Oct 13, 2022
71ce99e
Some more update
Oct 13, 2022
20dd065
Minor change
Oct 13, 2022
9ddf2ed
Some more doc updates
Oct 13, 2022
794dce3
Review comments addressed
Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 27 additions & 14 deletions doc/README.open_ce_build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,6 @@ while a similar build for pytorch may look like this:
open-ce build env pytorch-env.yaml
```

Note that `bazel` is used to build `TensorFlow`. By default, `bazel` caches the files/source code it downloads during the build to ~/.cache/bazel. In case the home directory is low in memory, the packages using bazel as a build tool might fail.
One can change the cache directory location used by bazel by setting `$TEST_TMPDIR` in the `build.sh` of the respective feedstock like this:

```shell
export TEST_TMPDIR=/dev/shm/.cache
bazel build ...
```

Other environment files for other packages can also be found in the `envs`
directory; simply specify the file for whichever package environment you want.

Expand All @@ -49,6 +41,27 @@ directory; simply specify the file for whichever package environment you want.
> you may do so if you wish to perform an individual build of your own
> for any given Open-CE feedstock repository.

#### Tips for bazel builds ####

Note that `bazel` is used to build `TensorFlow`. By default, `bazel` caches the files/source code it downloads during the build to ~/.cache/bazel. In case the home directory is low in memory, the packages using bazel as a build tool might fail.
One can change the cache directory location used by bazel in two ways as follows -

1. By setting `$TEST_TMPDIR` in the `build.sh` of the respective feedstock like this:

```shell
export TEST_TMPDIR=/dev/shm/.cache
bazel build ...
```

2. By making a global change in user specific `~/.bazelrc` for all packages that use bazel as a build tool. This way one doesn't need to modify every feedstock:

```shell
echo "startup --output_user_root=/dev/shm/.cache" >> ~/.bazelrc
```

Also, in case the build fails, many a times, a stale process remains alive. And this could slow down subsequent builds.
Make sure to kill this stale bazel process before retrying the builds.

### Container build

The `--container_build` option will build an image and run the build command
Expand Down Expand Up @@ -455,14 +468,14 @@ For example:
GCC 11 setup is automated if the builds are done in a podman container using `--container_build` option. Please see [`Dockerfile`](https://github.com/open-ce/open-ce-builder/blob/main/open_ce/images/builder/Dockerfile-p10) used for containerized build of these packages.

#### Build packages
Power10 MMA Optimization is applicable for cpu only builds. One has to use `--ppc_arch=p10` flag in the `open-ce build env` or `open-ce build feedstock` command to build P10 enabled packages. Another important argument which is must to build these packages is `--conda_build_config=open-ce/envs/conda_build_config.yaml,open-ce/envs/conda_build_config_p10.yaml`.[`conda_build_config_p10.yaml`](https://github.com/open-ce/open-ce/blob/main/envs/conda_build_config_p10.yaml) contains Power10 specific settings.
Power10 MMA Optimization is applicable for cpu only builds. To build Power10 packages, use one of the following options:

For example:
```shell
open-ce build env --build_type=cpu --ppc_arch=p10 --conda_build_config=open-ce/envs/conda_build_config.yaml,open-ce/envs/conda_build_config_p10.yaml tensorflow-env.yaml
```
1. To build an individual environment: open-ce build env --ppc_arch=p10 --build_type=cpu --conda_build_config=open-ce/envs/conda_build_config.yaml,open-ce/envs/conda_build_config_p10.yaml <environment yaml>.

2. To build an individual feedstock: open-ce build feedstock --ppc_arch=p10 --build_type=cpu --conda_build_config=../open-ce/envs/conda_build_config.yaml,../open-ce/envs/conda_build_config_p10.yaml

3. To build all Power10 enabled packages in one go: open-ce build env --ppc_arch=p10 --build_type=cpu opence-p10-env.yaml

Open-CE also contains [`open-ce/envs/opence-p10-env.yaml`](https://github.com/open-ce/open-ce/blob/main/envs/opence-p10-env.yaml) which builds all the Power10 enabled packages in one go.

#### Using packages with Power10 MMA optimization
When using packages that were built with ppc_arch=p10, note that:
Expand Down