chore: Follow-up Documentation cleanup #159
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
KavithaSiva
changed the title
marikaner
previously requested changes
Sep 23, 2024
Co-authored-by: Marika Marszalkowski <[email protected]>
Co-authored-by: Marika Marszalkowski <[email protected]>
Co-authored-by: Marika Marszalkowski <[email protected]>
Co-authored-by: Marika Marszalkowski <[email protected]>
Co-authored-by: Marika Marszalkowski <[email protected]>
Co-authored-by: Marika Marszalkowski <[email protected]>
Co-authored-by: Marika Marszalkowski <[email protected]>
…s into documentation/minor-cleanup
deekshas8
reviewed
Sep 25, 2024
deekshas8
reviewed
Sep 25, 2024
deekshas8
reviewed
Sep 25, 2024
…s into documentation/minor-cleanup
ZhongpinWang
reviewed
Oct 2, 2024
| SAP AI Core manages access to generative AI models through the global AI scenario `foundation-models`. | ||
| Creating a deployment for a model requires access to this scenario. | ||
|
|
||
| Each model, model version, and resource group allows for a one-time deployment. |
There was a problem hiding this comment.
Suggested change
| Each model, model version, and resource group allows for a one-time deployment. | |
| Deployment requires model name, model version and resource group. |
There was a problem hiding this comment.
Subtle differences between the two, so I will use the original sentence, as it talks about relationship rather than what is required by the API.
| SAP AI Core manages access to generative AI models through the global AI scenario `foundation-models`. | ||
| Creating a deployment for a model requires access to this scenario. | ||
|
|
||
| Each model, model version, and resource group allows for a one-time deployment. |
There was a problem hiding this comment.
Same as before, a bit confusing to me.
Comment on lines
+44
to
+52
| ## Relationship between Orchestration and Resource Groups | ||
|
|
||
| SAP AI Core manages access to orchestration of generative AI models through the global AI scenario `orchestration`. | ||
| Creating a deployment for enabling orchestration capabilities requires access to this scenario. | ||
|
|
||
| [Resource groups](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/resource-groups?q=resource+group) represent a virtual collection of related resources within the scope of one SAP AI Core tenant. | ||
| Each resource group allows for a one-time orchestration deployment. | ||
|
|
||
| Consequently, each orchestration deployment uniquely maps to a resource group within the `orchestration` scenario. |
There was a problem hiding this comment.
[pp] I would suggest we extract this section into a separate file as it has been repeated many times. It will be very hard to maintain so many packages. At least we should do this definitely in the future.
There was a problem hiding this comment.
As, the deployment requirements change between orchestration and foundation-models. I would prefer to write about it in the dedicated client document instead of a separate file, as this would be more confusing.
Co-authored-by: Zhongpin Wang <[email protected]>
Co-authored-by: Zhongpin Wang <[email protected]>
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
reviewed
Oct 2, 2024
deekshas8
approved these changes
Oct 2, 2024
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.
Context
Follow-up of comments not addressed in:
Definition of Done
[ ] Code is tested (Unit, E2E)[ ] Error handling created / updated & covered by the tests above[ ] (Optional) Aligned changes with the Java SDK[ ] (Optional) Release notes updated