docs: Polish ReadME #1635
docs: Polish ReadME #1635
Conversation
Douglasymlai
added
P0
docs/images/workforce.png
Outdated
There was a problem hiding this comment.
the last sentence of the doc in the image should be removed
| > **Data (Hosted on Hugging Face)** | ||
|
|
||
| | Dataset | Chat format | Instruction format | Chat format (translated) | | ||
| |----------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| | ||
| | **AI Society** | [Chat format](https://huggingface.co/datasets/camel-ai/ai_society/blob/main/ai_society_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/ai_society/blob/main/ai_society_instructions.json) | [Chat format (translated)](https://huggingface.co/datasets/camel-ai/ai_society_translated) | | ||
| | **Code** | [Chat format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_chat.tar.gz) | [Instruction format](https://huggingface.co/datasets/camel-ai/code/blob/main/code_instructions.json) | x | | ||
| | **Math** | [Chat format](https://huggingface.co/datasets/camel-ai/math) | x | x | | ||
| | **Physics** | [Chat format](https://huggingface.co/datasets/camel-ai/physics) | x | x | | ||
| | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x | |
There was a problem hiding this comment.
this part shouldn't under 2. Utilize Various LLMs as Backends
There was a problem hiding this comment.
Should we remove this part entirely, or should we place it somewhere else?
README.md
Outdated
| | **Chemistry** | [Chat format](https://huggingface.co/datasets/camel-ai/chemistry) | x | x | | ||
| | **Biology** | [Chat format](https://huggingface.co/datasets/camel-ai/biology) | x | x | | ||
|
|
||
| ### 3. Visualizations of Instructions and Tasks |
There was a problem hiding this comment.
this part shouldn't belong to Tech Stack, same as 2. Utilize Various LLMs as Backends
README.md
Outdated
| | **Code** | [Instructions](https://atlas.nomic.ai/map/902d6ccb-0bbb-4294-83a8-1c7d2dae03c8/ace2e146-e49f-41db-a1f4-25a2c4be2457) | [Tasks](https://atlas.nomic.ai/map/efc38617-9180-490a-8630-43a05b35d22d/2576addf-a133-45d5-89a9-6b067b6652dd) | | ||
| | **Misalignment** | [Instructions](https://atlas.nomic.ai/map/5c491035-a26e-4a05-9593-82ffb2c3ab40/2bd98896-894e-4807-9ed8-a203ccb14d5e) | [Tasks](https://atlas.nomic.ai/map/abc357dd-9c04-4913-9541-63e259d7ac1f/825139a4-af66-427c-9d0e-f36b5492ab3f) | | ||
|
|
||
| <br> | ||
|
|
||
| ## Installation |
There was a problem hiding this comment.
how about remove the detailed Installation guidance in readme and set one separated file for Installation? just like how we did for contribution guideline https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md
There was a problem hiding this comment.
Yes, that sounds like a good plan. I believe the best approach would be to include the detailed installation in the documentation and maintain a brief summary in the repository's ReadMe file.
README.md
Outdated
|
|
||
| Please reachout to us on [CAMEL discord](https://discord.camel-ai.org/) if you encounter any issue set up CAMEL. | ||
|
|
||
| > If you would like to contribute to CAMEL refer to our [Contributing Guidelines](https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
this shouldn't under ### Seeking Help
There was a problem hiding this comment.
I designed this section to encourage the conversion of individuals joining our community. Are there any other channels through which we can support our users?
README.md
Outdated
|
|
||
| - `Self-Instruct` from *Yizhong Wang et al.*: [SELF-INSTRUCT: Aligning Language Models with Self-Generated Instructions](https://arxiv.org/pdf/2212.10560). [[Example](https://github.com/camel-ai/camel/blob/master/examples/datagen/self_instruct/self_instruct.py)] | ||
| ## Research |
There was a problem hiding this comment.
for this part could we move it up, after Tech Stack session?
README.md
Outdated
| >We also welcome you to help CAMEL grow by sharing it on social media, at events, or during conferences. Your support makes a big difference! | ||
|
|
||
|
|
||
| ## Community & Contact |
There was a problem hiding this comment.
this part should be moved up, let's adjust the order based on importance,Citation and License could in the bottom
|
I have updated the PR based on the comments. @Wendong-Fan |
Co-authored-by: Wendong <w3ndong.fan@gmail.com>
Description
This polishes the ReadMe content, graphics and layout. close #1256
Checklist
Go over all the following points, and put an
xin all the boxes that apply.Fixes #issue-numberin the PR description (required)pyproject.tomlandpoetry.lockIf you are unsure about any of these, don't hesitate to ask. We are here to help!