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.

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

Improved setup & example documentation #92

Open
larf311 opened this issue Jul 19, 2022 · 1 comment
Open

Improved setup & example documentation #92

larf311 opened this issue Jul 19, 2022 · 1 comment
Labels
component:rai-sdk-python type:documentation Improvements or additions to documentation

Comments

@larf311
Copy link

larf311 commented Jul 19, 2022

  • In documentation and examples, it was unclear to new Python user (me) how the setup code is being invoked, for example here: https://docs.relational.ai/rkgms/sdk/python-sdk#configuration. Is this in a .py file? Run on command line with python3? Specifying the filename or putting python3 or even >>> in front of these commands would be helpful. It would also be helpful to include an example of using the python3 (or other version) command to run an example API call early on in the documentation.
  • Scanty documentation/ can’t find documentation around railib functions, e.g. show, config, etc.
  • Suggestions to add to documentation:
    • What OAuth permissions are needed to use different api utilities
    • Example of how to install models in a folder (prepend foldername/ to model name)

https://relationalai.slack.com/archives/C039JJ2ECSE/p1658193736867969

@bradlo bradlo added type:documentation Improvements or additions to documentation component:rai-sdk-python labels Oct 5, 2022
@billscheidel-rai
Copy link

Note: This issue has been migrated to https://relationalai.atlassian.net/browse/RAI-6045.

This link is only accessible to employees of RelationalAI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:rai-sdk-python type:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants