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

Tutorial notebooks that can be directly opened in colab #90

Merged
merged 3 commits into from
Jun 7, 2024

Conversation

ProKil
Copy link
Member

@ProKil ProKil commented Jun 5, 2024

A follow-up to #73. This brings version control to the notebook tutorials.

Reviewers: none of the links could be opened as-is before merging into main. You can change main
in the links to doc/colab-notebook-files in order to view the links.

📑 Description

Added two jupyter notebooks under notebooks/tutorials.
Updated link in the readme.
Minor update of the sotopia logo.

Also closes #91.

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed
  • Branch name follows type/descript (e.g. feature/add-llm-agents)
  • Ready for code review

ℹ Additional Information

@ProKil ProKil requested a review from XuhuiZhou June 6, 2024 15:32
@ProKil ProKil mentioned this pull request Jun 6, 2024
@ProKil ProKil requested a review from lwaekfjlk June 6, 2024 15:46
@lwaekfjlk
Copy link
Member

just curious what is the meaning of this icon

@ProKil
Copy link
Member Author

ProKil commented Jun 6, 2024

just curious what is the meaning of this icon

Lol, it is inspired by the chatting interface: the black semi- and quarter circles are chat bubbles. And you can see a white S in the middle.

@lwaekfjlk
Copy link
Member

ah, make sense

@ProKil
Copy link
Member Author

ProKil commented Jun 7, 2024

@lwaekfjlk @XuhuiZhou feel free to leave more feedback on this. More content? Better interface? Thank you!

@XuhuiZhou XuhuiZhou merged commit 9351c5e into main Jun 7, 2024
5 checks passed
@XuhuiZhou XuhuiZhou deleted the doc/colab-notebook-files branch June 7, 2024 15:50
XuhuiZhou added a commit that referenced this pull request Jun 7, 2024
@XuhuiZhou XuhuiZhou restored the doc/colab-notebook-files branch June 7, 2024 15:53
@ProKil
Copy link
Member Author

ProKil commented Jun 7, 2024

Thanks @XuhuiZhou

@XuhuiZhou
Copy link
Member

@ProKil Sorry I accidentally merged it lolll

I indeed has one small comment:

For the markdown here, any chance you can link to the sotopia docs that include instructions for different platforms?

Download Redis: This code block is exactly the same as

I guess for this instruction here, for Mac users, people are wondering if they can stop the server and restart with the previously saved data. (since they are usually using their personal laptop)
image

@lwaekfjlk
Copy link
Member

lwaekfjlk commented Jun 7, 2024

Thanks @ProKil for the contribution and thanks @XuhuiZhou for the comments, looks good to me.

@ProKil ProKil deleted the doc/colab-notebook-files branch June 13, 2024 17:14
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.

[BUG]: Tuturial failed?
3 participants