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/update badges for Google Colab and Lightning Studio #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sugatoray
Copy link
Contributor

@sugatoray sugatoray commented Jun 23, 2024

Added/updated badges for open-in-colab and open-in-lightning-studio:

  • formatted badges to reuse the same link for colab
  • added Lightning Studio badges
    • for whole repo (at the top)
    • for individual example notebooks (next to colab badges)

Lightning Studio provides a managed service and free compute alike Google Colab. Offers both VS Code and Jupyter Notebook in-browser. For individuals it provides free GPU, CPU and storage (free credits renew monthly). Since the managed service gets the entire repo setup in seconds, it could be useful to provide a link to Lightning Studio alongside Google Colab.

cc: @vinid

- formatted badges to reuse the same link for colab
- added Lightning Studio badges 
  - for whole repo (at the top)
  - for individual example notebooks (next to colab badges)
Comment on lines +4 to 8
[![Open In Colab][#colab-svg]][#colab-demonb-package]
[![Open In Lightning Studio][#lightning-studio-svg]][#oils-repo-package]
[![GitHub license](https://img.shields.io/badge/License-MIT-blue.svg)][#license-gh-package]
[![Arxiv](https://img.shields.io/badge/arXiv-2406.07496-B31B1B.svg)][#arxiv-paper-package]
[![Documentation Status](https://readthedocs.org/projects/textgrad/badge/?version=latest)][#docs-package]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rendered Preview:

image

Comment on lines +118 to +134
| Example | Colab Link | Lightning Studio Link |
|-------------------------------------------------|:-----------------------------------------------:|:--------------------------------------------------------------------:|
| Introduction to TextGrad Primitives | [![Open In Colab][#colab-svg]][#colab-nb-001] | [![Open In Lightning Studio][#lightning-studio-svg]][#oils-nb-001] |
| Optimizing a Code Snippet and Define a New Loss | [![Open In Colab][#colab-svg]][#colab-nb-002] | [![Open In Lightning Studio][#lightning-studio-svg]][#oils-nb-002] |
| Prompt Optimization | [![Open In Colab][#colab-svg]][#colab-nb-003] | [![Open In Lightning Studio][#lightning-studio-svg]][#oils-nb-003] |
| Solution Optimization | [![Open In Colab][#colab-svg]][#colab-nb-004] | [![Open In Lightning Studio][#lightning-studio-svg]][#oils-nb-004] |

</div>

<!--- Google Colab for Notebooks --->
[#colab-svg]: https://colab.research.google.com/assets/colab-badge.svg
[#colab-nb-001]: https://colab.research.google.com/github/zou-group/TextGrad/blob/main/examples/notebooks/Primitives.ipynb
[#colab-nb-002]: https://colab.research.google.com/github/zou-group/textgrad/blob/main/examples/notebooks/Tutorial-Test-Time-Loss-for-Code.ipynb
[#colab-nb-003]: https://colab.research.google.com/github/zou-group/TextGrad/blob/main/examples/notebooks/Prompt-Optimization.ipynb
[#colab-nb-004]: https://colab.research.google.com/github/zou-group/TextGrad/blob/main/examples/notebooks/Tutorial-Solution-Optimization.ipynb

<!--- Lightning Studio Badges for Notebooks --->
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rendered Preview:

image

@sugatoray
Copy link
Contributor Author

@mertyg / @vinid : Please let me know if adding these badges are okay with you.

@vinid
Copy link
Collaborator

vinid commented Jun 28, 2024

hello thanks so much! we are working on some updates so we can't merge this yet but will do so soon!

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.

2 participants