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

Remove pickling demo and include other minor fixes #261

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jaggiK
Copy link
Contributor

@jaggiK jaggiK commented Nov 11, 2024

This PR addresses the following updates:

Removal of Pickling Demo: The demo for pickling states has been removed as it is currently broken.
Dependencies: Included a pip install instruction for Adalflow to streamline dependencies.
Import Fixes: Fixed import issues for Parameter and Sequential to ensure compatibility and proper functionality.
OpenAI API Key Entry: Enabled API key entry via keyboard input, aligning with the interaction method in other notebooks.

Testing:
This PR has been tested successfully on both a local machine and Google Colab to verify functionality.

Notes:
The pickling demo can be reintroduced in the future once the issues are resolved. More on this issue can be found here

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@liyin2015 liyin2015 left a comment

Choose a reason for hiding this comment

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

@jaggiK appreciate your contribution. This is great, but this would be even better for us and be more final:

For every tutorial, like the screenshot, we provide two files to complement the documentation:

  • .py code located in /tutorials
  • .ipynb (auto-converted to colab) located in /notebooks/tutorials (name it adalflow_component.ipynb)

Screenshot 2024-11-11 at 11 44 50 AM

Thus, we would appreciate you can do this:

  • convert the component.ipynb code to component.py
  • create adalflow_component.ipynb in notebooks/tutorials
  • Replace the link in colab tutorial http://adalflow.sylph.ai/ . The new link you can find in the README.md of notebooks dir

Let me know if this make sense to you @jaggiK

@fm1320 for context on working on documentation

@jaggiK
Copy link
Contributor Author

jaggiK commented Nov 11, 2024

Could you provide further clarification on the third point? I've made some changes based on my understanding, let me know if I've misinterpreted the requirement.

@fm1320
Copy link
Collaborator

fm1320 commented Nov 21, 2024

@jaggiK Hi, basically you need to edit the docs/source/tutorials files so that the links appear as part of the documentation. So that they appear here like open in colab:

More info in the contributing guide here: https://adalflow.sylph.ai/contributor/contribution.html
image

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.

3 participants