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

Update docker_install.md #1368

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update docker_install.md #1368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions packaging/docker_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Follow these instructions to build the AIMET code:

> NOTE: **If you are inside the docker, set `WORKSPACE="<absolute_path_to_workspace>"` again.**
```bash
cd $WORKSPACE
cd $WORKSPACE/aimet
mkdir build && cd build

# Run cmake (be sure to set the flags in the below command depending on your variant)
Expand All @@ -79,28 +79,28 @@ make -j8

After a successful build, install the package using the following instructions:
```bash
cd $WORKSPACE/build
cd $WORKSPACE/aimet/build
make install
```
Once the installation step is complete, the AIMET package is created at `$WORKSPACE/build/staging/universal/lib/`.
Once the installation step is complete, the AIMET package is created at `$WORKSPACE/aimet/build/staging/universal/lib/`.

## Setup paths
Setup the package and library paths as follows:
```bash
export PYTHONPATH=$WORKSPACE/build/staging/universal/lib/python:$PYTHONPATH
export LD_LIBRARY_PATH=$WORKSPACE/build/staging/universal/lib/python:$LD_LIBRARY_PATH
export PYTHONPATH=$WORKSPACE/aimet/build/staging/universal/lib/python:$PYTHONPATH
export LD_LIBRARY_PATH=$WORKSPACE/aimet/build/staging/universal/lib/python:$LD_LIBRARY_PATH
```
At this point, we are all set to use AIMET!

## Usage examples and documentation
The following steps would generate AIMET documentation including the user guide, examples and API documentation at `$WORKSPACE/build/staging/universal/Docs`:
The following steps would generate AIMET documentation including the user guide, examples and API documentation at `$WORKSPACE/aimet/build/staging/universal/Docs`:

```bash
cd $WORKSPACE/build
cd $WORKSPACE/aimet/build
make doc
```

To begin navigating the documentation, open the page `$WORKSPACE/build/staging/universal/Docs/user_guide/index.html` on any browser.
To begin navigating the documentation, open the page `$WORKSPACE/aimet/build/staging/universal/Docs/user_guide/index.html` on any browser.

## Docker information
Code may *optionally* be developed inside a development docker container. This section describes how to build a docker image and launch a container using the provided [Dockerfiles](../Jenkins).
Expand Down