Update Cloud Storage Docs #1731
Conversation
|
Thanks for submitting this PR, we'll give it a review as soon as possible |
docs/persist.rst
Outdated
| @@ -55,7 +55,13 @@ Rasa NLU supports using `S3 <https://aws.amazon.com/s3/>`_ and | |||
|
|
|||
| If there is no container with the name ``AZURE_CONTAINER`` Rasa will create it. | |||
|
|
|||
| Models are gzipped before saving to cloud. | |||
| Models are gzipped before saving to cloud. The gzipped file naming convention | |||
| is `{PROJECT}___{MODEL_NAME}.tar.gz` and should be in the root folder of the storage service. | |||
There was a problem hiding this comment.
| is `{PROJECT}___{MODEL_NAME}.tar.gz` and should be in the root folder of the storage service. | |
| is `{PROJECT}{MODEL_NAME}.tar.gz` and it is stored in the root folder of the storage service. |
There was a problem hiding this comment.
Was this behavior changed in v0.14? We are using v0.13.7 so I tested on that which has the ___ in between model and project name. @wochinge
There was a problem hiding this comment.
Line 96-100 in persistor.py:
@staticmethod
def _project_prefix(project: Text) -> Text:
p = project or RasaNLUModelConfig.DEFAULT_PROJECT_NAME
return '{}___'.format(p)
|
@careless25 Thanks for your contribution. I left a few comments. Implement them and then the change is ready to go 🚀 |
|
Code Climate has analyzed commit b43b816 and detected 0 issues on this pull request. View more on Code Climate. |
|
@wochinge Addressed your comments |
| @@ -55,7 +55,13 @@ Rasa NLU supports using `S3 <https://aws.amazon.com/s3/>`_ and | |||
|
|
|||
| If there is no container with the name ``AZURE_CONTAINER`` Rasa will create it. | |||
|
|
|||
| Models are gzipped before saving to cloud. | |||
| Models are gzipped before they are saved in the cloud. The gzipped file naming convention | |||
| is `{PROJECT}___{MODEL_NAME}.tar.gz` and it is stored in the root folder of the storage service. | |||
There was a problem hiding this comment.
@careless25 Sure it is not {PROJECT}{MODEL_NAME}.tar.gz?
There was a problem hiding this comment.
Yes, see lines 96-100 in persistor.py
#1731 (comment)
There was a problem hiding this comment.
👍 You know the code better than I - awesome job!
docs/persist.rst
Outdated
| Models are gzipped before saving to cloud. | ||
| Models are gzipped before they are saved in the cloud. The gzipped file naming convention | ||
| is `{PROJECT}___{MODEL_NAME}.tar.gz` and it is stored in the root folder of the storage service. | ||
| Currently, you are not able manually to specify the path on cloud storage. |
There was a problem hiding this comment.
| Currently, you are not able manually to specify the path on cloud storage. | |
| Currently, you are not able to manually specify the path on the cloud storage. |
docs/persist.rst
Outdated
| is `{PROJECT}___{MODEL_NAME}.tar.gz` and it is stored in the root folder of the storage service. | ||
| Currently, you are not able manually to specify the path on cloud storage. | ||
|
|
||
| If storing trained models, Rasa NLU will gzip the new model and upload to the container. If retrieving/loading models |
There was a problem hiding this comment.
| If storing trained models, Rasa NLU will gzip the new model and upload to the container. If retrieving/loading models | |
| If storing trained models, Rasa NLU will gzip the new model and upload it to the container. If retrieving/loading models |
docs/persist.rst
Outdated
| Currently, you are not able manually to specify the path on cloud storage. | ||
|
|
||
| If storing trained models, Rasa NLU will gzip the new model and upload to the container. If retrieving/loading models | ||
| from the cloud storage, Rasa NLU will download the gzipped model locally an extract the contents to the location |
There was a problem hiding this comment.
| from the cloud storage, Rasa NLU will download the gzipped model locally an extract the contents to the location | |
| from the cloud storage, Rasa NLU will download the gzipped model locally and extract the contents to the location |
|
@careless25 Thanks! I added a few more comments! |
|
@wochinge Fixed. For the |
Proposed changes: Documentation was lacking on how the storing and retrieval of model works.
Might help with:
#1426
Status (please check what you already did):