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

[DOC] Add tutorial for adding your own objects #368

Merged

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Mar 19, 2024

This is a work in progress.

This is a continuation of PR #358. It was created by rebasing PR #358 to include the merged commits from PR #362 that removes max_input_size.

This PR adds a tutorial to help users or developers add assistants and source storages for LLMs to Ragna that are not currently supported.

TODO: Add usage example with the Python API

This is just a first draft what will be iterated on later

Remove small typo
- Add subheading
- Shorten long lines
pmeier
pmeier previously requested changes Mar 19, 2024
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_adding_components.py Outdated Show resolved Hide resolved
@smokestacklightnin smokestacklightnin force-pushed the tutorial/adding-more-components/rebased branch from 228e6a0 to 88c95d0 Compare April 10, 2024 23:25
@pmeier pmeier marked this pull request as ready for review April 23, 2024 16:19
Copy link
Member

@pmeier pmeier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've fixed most of my own comments. There is some slight cleanup needed, but this is good for a first round of review from someone else.

@pmeier pmeier dismissed their stale review April 23, 2024 16:36

I've fixed my own comments

@pmeier pmeier requested a review from pavithraes April 24, 2024 07:14
@pmeier pmeier added this to the 0.2.1 milestone Apr 24, 2024
Copy link
Member

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! Most of the suggestions are related to language being used, specifically avoiding phrases like simply or just and using active voice.

I have a note on my end to improve the existing tutorials to also use second person in the tutorials (i.e. "you" rather than "we") on this project, so not including those as review suggestions here.

docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
docs/tutorials/gallery_custom_components.py Outdated Show resolved Hide resolved
Copy link
Member

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates, looks good to me :)

@pmeier pmeier merged commit c527344 into Quansight:main May 16, 2024
10 checks passed
pmeier added a commit that referenced this pull request Jun 28, 2024
Co-authored-by: Philip Meier <github.pmeier@posteo.de>
Co-authored-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
pmeier added a commit that referenced this pull request Jun 28, 2024
Co-authored-by: Philip Meier <github.pmeier@posteo.de>
Co-authored-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants