updated fiab documentation #285
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
myungjin
reviewed
Dec 2, 2022
docs/03-fiab.md
Outdated
| minikube delete | ||
| ``` | ||
| This development environment is mainly tested under MacOS. | ||
| The fiab is also tested under Archlinux. Hence, it may work on other Linux distributions such as Ubuntu. |
There was a problem hiding this comment.
Suggested change
| The fiab is also tested under Archlinux. Hence, it may work on other Linux distributions such as Ubuntu. | |
| The fiab env is also tested under linux distributions such as Ubuntu, Amazon Linux 2, Archlinux, etc. |
docs/03-fiab.md
Outdated
|
|
||
| ## Running a test ML job | ||
| In order to run a sample mnist job, refer to instructions at [mnist example](04-examples.md#mnist). | ||
| ## Fiab installation steps: |
There was a problem hiding this comment.
Suggested change
| ## Fiab installation steps: | |
| ## Fiab installation guideline | |
| Follow one of the links below that matches operating system under consideration: |
docs/03.A-fiab-linux.md
Outdated
| @@ -1,12 +1,13 @@ | |||
| # Fiab installation in linux | |||
| The fiab env was tested under Archlinux in a x86 machine. But steps can be followed for similar OS. | |||
There was a problem hiding this comment.
Suggested change
| The fiab env was tested under Archlinux in a x86 machine. But steps can be followed for similar OS. | |
| This guideline is mainly for Ubuntu in a x86 machine and steps can be followed for other linux distributions with their respective package mangers. |
docs/03.B-fiab-amzn-linux-gpu.md
Outdated
| ``` | ||
| When `docker` driver is in use, run ```minikube config set driver docker``` to make docker driver default. These changes will take effect upon a minikube delete and then a minikube start. | ||
|
|
||
| We recommend a disk space of 100GB to allow sufficient disk space to store the flame container images and other images in the minikube VM. |
There was a problem hiding this comment.
The lines 100-113 are not needed because of https://github.com/cisco-open/flame/pull/285/files#diff-ac8447bfb60ee1cdba24bb93c02d1b55f3f34d02f4c6dce9718b31d8864a769cR60.
Please remove them and change "## Starting minikube" to "## Configuring addons".
docs/03.A-fiab-linux.md
Outdated
|
|
||
| We recommend a disk space of 100GB to allow sufficient disk space to store the flame container images and other images in the minikube VM. | ||
|
|
||
| Next, `ingress` and `ingress` addons need to be installed with the following command: |
There was a problem hiding this comment.
Suggested change
| Next, `ingress` and `ingress` addons need to be installed with the following command: | |
| Next, `ingress` and `ingress-dns` addons need to be installed with the following command: |
docs/03.B-fiab-amzn-linux-gpu.md
Outdated
|
|
||
| We recommend a disk space of 100GB to allow sufficient disk space to store the flame container images and other images in the minikube VM. | ||
|
|
||
| Next, `ingress` and `ingress` addons need to be installed with the following command: |
There was a problem hiding this comment.
Suggested change
| Next, `ingress` and `ingress` addons need to be installed with the following command: | |
| Next, `ingress` and `ingress-dns` addons need to be installed with the following command: |
docs/03.C-fiab-mac.md
Outdated
|
|
||
| We recommend a disk space of 100GB to allow sufficient disk space to store the flame container images and other images in the minikube VM. | ||
|
|
||
| Next, `ingress` and `ingress` addons need to be installed with the following command: |
There was a problem hiding this comment.
Suggested change
| Next, `ingress` and `ingress` addons need to be installed with the following command: | |
| Next, `ingress` and `ingress-dns` addons need to be installed with the following command: |
RaviKhandavilli
force-pushed
the
fiab-documentation
branch
from
6912190
to
5352f2d
Compare
myungjin
reviewed
Dec 2, 2022
docs/03-fiab.md
Outdated
| Unless a fresh minikube instance is needed, simply stopping the minikube (i.e., `minikube stop`) instance would be useful | ||
| to save time for development and testing. | ||
| * [Linux](03.A-fiab-linux.md) | ||
| * [Amazon Linux with GPU](03.B-fiab-ec2.md) |
There was a problem hiding this comment.
I think this link is broken because the file is deleted.
docs/03.A-fiab-linux.md
Outdated
|
|
||
| ### Linux Prerequisites | ||
| # Fiab installation in linux | ||
| This guideline is mainly for Ubuntu in a x86 machine and steps can be followed for other linux distributions with their respective package mangers. |
There was a problem hiding this comment.
Suggested change
| This guideline is mainly for Ubuntu in a x86 machine and steps can be followed for other linux distributions with their respective package mangers. | |
| This guideline is mainly for Ubuntu in a x86 machine and steps can be followed for other linux distributions with their respective package managers. |
docs/03.B-fiab-amzn-linux-gpu.md
Outdated
| This guideline primarily focus on installting fiab in amazon linux with mounted NVIDIA GPUs. | ||
|
|
||
| ## Prerequisites | ||
| AWS EC2 instance with Amazon Linux 2 image and GPU |
There was a problem hiding this comment.
This is not a complete sentence. Please revise.
RaviKhandavilli
force-pushed
the
fiab-documentation
branch
from
5352f2d
to
9a51275
Compare
Added complete steps to install fiab for each distribution separately
RaviKhandavilli
force-pushed
the
fiab-documentation
branch
from
9a51275
to
7ea5fd4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added complete steps to install fiab for each distribution separately