Skip to content

Commit

Permalink
Merge pull request #22 from camel-ai/update_readme
Browse files Browse the repository at this point in the history
Update readme with demo video and star history
  • Loading branch information
yiyiyi0817 authored Jan 5, 2025
2 parents 695e683 + 216d30f commit 37c1e9d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ ______________________________________________________________________

🔥 Integrated Recommendation Systems: Features interest-based and hot-score-based recommendation algorithms, simulating how users discover content and interact within social media platforms.

## 📺 Demo Video

[![demo_video](assets/demo_preview.png)](https://www.youtube.com/watch?v=wjLHrdZ1Smk&ab_channel=CamelAI)

## 🔧 Installation

### Step 1: Clone the Repository
Expand Down Expand Up @@ -128,6 +132,9 @@ To import your own user and post data, please refer to the JSON file format loca
# For Reddit
python scripts/reddit_gpt_example/reddit_simulation_gpt.py --config_path scripts/reddit_gpt_example/gpt_example.yaml

# For Reddit with Electronic Mall
python scripts/reddit_emall_demo/emall_simulation.py --config_path scripts/reddit_emall_demo/emall.yaml

# For Twitter
python scripts/twitter_gpt_example/twitter_simulation_large.py --config_path scripts/twitter_gpt_example/gpt_example.yaml
```
Expand Down Expand Up @@ -298,8 +305,11 @@ To discover how to create profiles for large-scale users, as well as how to visu

<!-- - Public release of our dataset on Hugging Face (November 05, 2024) -->

- Initial release of OASIS on arXiv (November 19, 2024)
- Initial release of OASIS github repository (November 19, 2024)
📣 Add the demo video and oasis's star history in the README. (January 5, 2025)

- Add an Electronic Mall in Reddit platform. (December 5, 2024)
- Initial release of OASIS on arXiv. (November 19, 2024)
- Initial release of OASIS github repository. (November 19, 2024)

## 🔗 Citation

Expand Down Expand Up @@ -333,6 +343,10 @@ An essential part of contributing involves not only submitting new features with
If you're keen on exploring new research opportunities or discoveries with our platform and wish to dive deeper or suggest new features, we're here to talk. Feel free to get in touch for more details at [email protected].
## 🌟 Star History
[![Star History Chart](https://api.star-history.com/svg?repos=camel-ai/oasis&type=Date)](https://star-history.com/#camel-ai/oasis&Date)
[arxiv-image]: https://img.shields.io/badge/arXiv-2407.01511-b31b1b.svg
[arxiv-url]: https://arxiv.org/abs/2411.11581
[discord-image]: https://img.shields.io/badge/Discord-CAMEL--AI-7289da?logo=discord&logoColor=white&color=7289da
Expand Down
Binary file added assets/demo_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37c1e9d

Please sign in to comment.