Skip to content

Improved setup & example documentation #92

@larf311

Description

@larf311
  • 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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions