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

Fixing grammatical errors and references #835

Merged
merged 1 commit into from
Feb 28, 2019
Merged

Fixing grammatical errors and references #835

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
11 changes: 3 additions & 8 deletions samples/ibm-samples/ffdl-seldon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Run `jupyter notebook` to start running your jupyter server and load the noteboo
- **model-class-name**: PyTorch model class name
- **model-class-file**: Model file that contains the PyTorch model class

## Credentials needed to stored in GitHub
## Credentials needed to be stored in GitHub
- **s3_url**: S3 Object storage endpoint for your FfDL training job.
- **s3_access_key_id**: S3 Object storage access key id
- **s3_secret_access_key**: S3 Object storage secret access key
Expand All @@ -55,12 +55,7 @@ Run `jupyter notebook` to start running your jupyter server and load the noteboo

## Naming convention for Training Model Files

Since libraries such as Spark and opencv are huge to put in the serving containers,
users who use libraries that are not from the standard PyTorch container from FfDL should consider
defining their PyTorch model class file in a separate Python file. This is because when python try to
load the model class from users' training files, python interpreter will need to read and import all the
Since libraries such as Spark and OpenCV are huge to put inside the serving containers, users who use libraries which are not from the standard PyTorch container from FfDL should consider defining their PyTorch model class file in a separate Python file. This is because when python tries to load the model class from users' training files, python interpreter will need to read and import all the
modules in memory within the same file in order to properly construct the module dependencies.

Therefore, by default users should consider naming their model class as `ModelClass` and only put the
model class code in a file call `model_class.py`. However, users can choose not to follow the naming convention
as long as they provide the model class and file name as part of the pipeline parameters.
Therefore, by default users should consider naming their model class as `ModelClass` and put the model class code in a file call `model_class.py`. However, users can choose not to follow the naming convention as long as they provide the model class and file name as part of the pipeline parameters.