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

Documentation Update #24

Closed
vedem1192 opened this issue Jun 8, 2023 · 6 comments
Closed

Documentation Update #24

vedem1192 opened this issue Jun 8, 2023 · 6 comments
Assignees
@vedem1192 @jayolee @moneill0
Labels
documentation Improvements or additions to documentation

Comments

@vedem1192
Copy link
Contributor

vedem1192 commented Jun 8, 2023 •
edited
Loading

Description

Go through the built documentation site and update as needed
More specifically, we want to :

  • add more relevant examples (langchain)
  • update examples to add the credentials object with api_endpoint
  • fix typos in PromptPattern Quick start
  • add documentation on the local server feature (the extension expects a user to define their model as shown in the example, ask james for more specific info)
@vedem1192
Copy link
Contributor Author

vedem1192 commented Jun 9, 2023 •
edited
Loading

Sphinx Documentation:

  • example section : group examples by functionality (add a new level/subsection)
    • templates will need to go under assets
Examples
  - Simple Examples (Getting Started)
        - Generate
        - Tokenize
        ...
  - Async Examples 
  - Local Server (locally served models)
  - Prompts 
  - Extensions
     - Langchain
     - Pandas
     - HuggingFace
  • Update example imports to import Credentials, Model, Metadata from genai (not genai.model)
from genail import Credentials, Model, Metadata

Action item :

  • @vedem1192 :
    • Get back to Young and Mairead regarding which examples we want to add to the sphinx pages
    • Update PromptPattern section -> Quickstart examples are too complex
  • @moneill0 : Sync with James for localserver tutorial and add it to Sphinx doc
  • @jayolee : looking into linking examples from the repo inside the sphinx doc (so we don't have to update in multiple places)

jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 12, 2023
docs: connected doc examples to existing files and updated cred and i…
98dbba0 
…mport on examples

- Updated doc examples to import examples from the existing files
- Updated examples to pass the API endpoint to generated credentials
- Updated import on examples to import modules from the right classes

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <<younglee@ibm.com>>
@jayolee jayolee mentioned this issue Jun 12, 2023
Merged
7 tasks
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 13, 2023
docs: removed unexisting folder import
51d2926 
- removed _static import from the conf.py

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <<younglee@ibm.com>>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 13, 2023
fix: lint fix
73146bf 
- lint fix on exmaples and docs

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <<younglee@ibm.com>>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 13, 2023
docs: connected doc examples to existing files and updated cred and i…
6158f64 
…mport on examples

- Updated doc examples to import examples from the existing files
- Updated examples to pass the API endpoint to generated credentials
- Updated import on examples to import modules from the right classes

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 13, 2023
docs: removed unexisting folder import
4c1e0d0 
- removed _static import from the conf.py

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 13, 2023
fix: lint fix
5c48757 
- lint fix on exmaples and docs

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee added the documentation Improvements or additions to documentation label Jun 13, 2023
@onkarbhardwaj
Copy link
Contributor

Update pre-requisites in the installation section of README with python and pip requirements @jayolee @moneill0

@moneill0 moneill0 mentioned this issue Jun 14, 2023
Merged
7 tasks
@jayolee
Copy link
Contributor

jayolee commented Jun 15, 2023

Update the model param of Model class's type hinting- Instead of being just ModelType, Union[ModelType, str]

@vedem1192
Copy link
Contributor Author

vedem1192 commented Jun 15, 2023 •
edited
Loading

Add example in the "Getting Started" section that import models by string name
Add a note in the readme.md (along with the pre-requisites) can import model with string (only use the string of a model that is and will stay available for the public in workbench)

jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 16, 2023
docs: restructure doc, updated font, updated genai.model paramtype
4fe4518 
- Restructured doc to have second section-example
- Updated font to IBM Plex Sans
- Updated genai.model's model paramtype to ModelType | str

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <<younglee@ibm.com>>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 16, 2023
docs: restructure doc, updated font, updated genai.model paramtype
34d1f35 
- Restructured doc to have second section-example
- Updated font to IBM Plex Sans
- Updated genai.model's model paramtype to ModelType | str

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee mentioned this issue Jun 16, 2023
Merged
7 tasks
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 20, 2023
docs: example spelling fix, added api_url to readme
477a103 
- Fixed spellings on examples
- Added API_URL examples to README

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee mentioned this issue Jun 20, 2023
Merged
7 tasks
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 20, 2023
docs: update the extension and prompt example links
d529178 
- Updated examples of extension and prompt

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 20, 2023
docs: fixed wrong url
6f9c5a3 
- fixed wrong link on the documentation

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 21, 2023
docs: added examples to the doc
45d96a7 
- Added examples to the doc

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <<younglee@ibm.com>>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 21, 2023
docs: updated links
ae8816c 
- Fixed wrong links on documentations

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee mentioned this issue Jun 21, 2023
Merged
7 tasks
onkarbhardwaj pushed a commit that referenced this issue Jun 21, 2023
@jayolee
docs: updated links (#51)
d4894b8 
- Fixed wrong links on documentations

Contributes to: #24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Co-authored-by: Ja Young Lee <younglee@ibm.com>
@jayolee
Copy link
Contributor

jayolee commented Jun 23, 2023

https://ibm.github.io/ibm-generative-ai/rst_source/genai.prompt.quickstart.annexe.html#file-synth-animal-yaml is missing indent

moneill0 pushed a commit to moneill0/ibm-generative-ai that referenced this issue Jun 26, 2023
@moneill0
docs: connected doc examples to existing files and updated cred and i…
353635b 
…mport on examples

- Updated doc examples to import examples from the existing files
- Updated examples to pass the API endpoint to generated credentials
- Updated import on examples to import modules from the right classes

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Signed-off-by: Mairead O'Neill <moneill@ibm.com>
moneill0 pushed a commit to moneill0/ibm-generative-ai that referenced this issue Jun 26, 2023
@moneill0
docs: removed unexisting folder import
28e9cf2 
- removed _static import from the conf.py

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Signed-off-by: Mairead O'Neill <moneill@ibm.com>
moneill0 pushed a commit to moneill0/ibm-generative-ai that referenced this issue Jun 26, 2023
@moneill0
fix: lint fix
f737fbe 
- lint fix on exmaples and docs

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Signed-off-by: Mairead O'Neill <moneill@ibm.com>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 28, 2023
docs: swapped modeltype to str, connected prompts to files
60f38af 
- Swapped ModelType enums to str on examples
- Connected annex files to the existing files under prompts
- Connected a prompt example to the example file
- Swapped not supported model name

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 28, 2023
docs: removed a line from connected prompt example
2c1e93a 
- updated included line numbers on a prompt example

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee mentioned this issue Jun 28, 2023
Merged
7 tasks
jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jun 29, 2023
docs: swapped unavailable model, updated endpoint info on readme, upd…
0241d56 
…ated generate param info

- Swapped unavailable model on examples
- Updated undpoint section on Readme to have more information
- Updated Readme's API link to bold
- Swapped ModelType to string in Readme
- Updated parameter information of GenerateParams about invalid ones with greedy decoding

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
moneill0 pushed a commit to moneill0/ibm-generative-ai that referenced this issue Jun 29, 2023
@moneill0
docs: example spelling fix, added api_url to readme
d12099c 
- Fixed spellings on examples
- Added API_URL examples to README

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
moneill0 pushed a commit to moneill0/ibm-generative-ai that referenced this issue Jun 29, 2023
@moneill0
docs: fixed wrong url
add449d 
- fixed wrong link on the documentation

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
moneill0 pushed a commit to moneill0/ibm-generative-ai that referenced this issue Jun 29, 2023
@jayolee @moneill0
docs: updated links (IBM#51)
610aabe 
- Fixed wrong links on documentations

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Co-authored-by: Ja Young Lee <younglee@ibm.com>
@jayolee
Copy link
Contributor

jayolee commented Jul 7, 2023

Add extension installation explanation link to the doc

jayolee pushed a commit to jayolee/ibm-generative-ai that referenced this issue Jul 11, 2023
docs: added tunes and files schemas
358bf8e 
- Added tunes and files schemas to the doc

Contributes to: IBM#24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
@jayolee jayolee mentioned this issue Jul 11, 2023
Merged
7 tasks
onkarbhardwaj pushed a commit that referenced this issue Jul 11, 2023
@onkarbhardwaj
docs: added tunes and files schemas
4691856 
- Added tunes and files schemas to the doc

Contributes to: #24

Signed-off-by: Ja Young Lee <younglee@ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vedem1192 vedem1192

@jayolee jayolee

@moneill0 moneill0

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@onkarbhardwaj @vedem1192 @jayolee @moneill0