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

Add Airtrain + Llama Index cookbook #16332

Merged
merged 7 commits into from
Oct 2, 2024

Conversation

augray
Copy link
Contributor

@augray augray commented Oct 2, 2024

Description

This PR adds a cookbook which describes how to use Airtrain with Llama Index. It introduces no new dependencies for any Llama Index packages, but the notebook for the cookbook depends on the Airtrain python package.

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

  • Yes
  • No

Type of Change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Added new unit/integration tests
  • Added new notebook (that tests end-to-end)
    (^ notebook requires user-specific API keys, but otherwise can be executed as-is end-to-end)
  • I stared at the code and made sure it makes sense

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
    (^ in the sense that the notebook itself is a test)
  • New and existing unit tests pass locally with my changes
  • I ran make format; make lint to appease the lint gods

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Oct 2, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@@ -0,0 +1,507 @@
{
Copy link
Contributor

@nerdai nerdai Oct 2, 2024

Choose a reason for hiding this comment

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

Can you kindly do a string search and replace in this notebook to change "Llama Index" (with space) to "LlamaIndex" (without space).


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

@@ -0,0 +1,507 @@
{
Copy link
Contributor

@nerdai nerdai Oct 2, 2024

Choose a reason for hiding this comment

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

Line #18.            if not isinstance(ev, CompletedDocumentRetrievalEvent):

It's actually not necessary to check the type of event. Under the hood, inspection is being done on the step's to determine its accepted events.


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed this

@@ -0,0 +1,507 @@
{
Copy link
Contributor

@nerdai nerdai Oct 2, 2024

Choose a reason for hiding this comment

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

Line #22.            return AirtrainDocumentDatasetEvent(metadata=dataset_meta)

you can probably just return StopEvent(result=metadata) here and omit the complete_workflow step.


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

Copy link
Contributor

@nerdai nerdai left a comment

Choose a reason for hiding this comment

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

Looks good @augray, though I have left a few minor comments.

@nerdai nerdai self-assigned this Oct 2, 2024
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Oct 2, 2024
@augray augray requested a review from nerdai October 2, 2024 20:23
@augray
Copy link
Contributor Author

augray commented Oct 2, 2024

Thanks for the review @nerdai ; I applied your suggested changes

Copy link
Contributor

@nerdai nerdai left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks @augray

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 2, 2024
@nerdai nerdai merged commit 539352b into run-llama:main Oct 2, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants