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

Adds ability to fork application via initialize_from #184

Merged
merged 5 commits into from
May 16, 2024
Merged

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented May 15, 2024

This gets at #181, by enabling someone
to fork an application easily from prior state.

You don't need to manage this outside of Burr,
it can now be done with the existing persisters.

I have included various error checks, just need
to write some tests for them.

Changes

  • ApplicationBuilder to take in some more parameters
  • updated conversational RAG notebook to show case the new feature

How I tested this

  • locally

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

This gets at #181, by enabling someone
to fork an application easily from prior state.

You don't need to manage this outside of Burr,
it can now be done with the existing persisters.

I have included various error checks, just need
to write some tests for them.
This tests that the error checks work to stop people from
not using the API correctly.
@skrawcz skrawcz changed the title Adds ability to fork application Adds ability to fork application via initialize_from May 15, 2024
@skrawcz skrawcz requested a review from elijahbenizzy May 15, 2024 05:19
@skrawcz skrawcz linked an issue May 15, 2024 that may be closed by this pull request
Copy link
Contributor

@elijahbenizzy elijahbenizzy 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, just some small comments on documentation

burr/core/application.py Outdated Show resolved Hide resolved
burr/core/application.py Outdated Show resolved Hide resolved
burr/core/application.py Outdated Show resolved Hide resolved
docs/concepts/state-persistence.rst Show resolved Hide resolved
@elijahbenizzy elijahbenizzy merged commit 2003164 into main May 16, 2024
7 checks passed
@elijahbenizzy elijahbenizzy deleted the add_fork branch May 16, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve persistence + debugging workflow
2 participants