modified readme

[Haiming94]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @Haiming94, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request reorganizes the project's documentation by removing detailed English challenge descriptions from the primary README.md and introducing a new README_cn.md to provide a localized, concise overview of the challenge along with comprehensive quick start instructions in Chinese. This change aims to improve accessibility for Chinese-speaking users and streamline the main English documentation.

Highlights

• Documentation Restructuring: The extensive English introduction, objectives, and challenge details have been removed from the main README.md file.
• Chinese Documentation Added: A new README_cn.md file has been introduced, providing a Chinese overview of the challenge, news, and detailed quick start instructions.
• Environment Setup Simplification: The create_env_nvidia.sh script and its corresponding mention in README.md have been removed, streamlining the environment setup guidance.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request introduces a Chinese version of the README (README_cn.md) which is a good addition for broader accessibility. However, it significantly reduces the information available in the English README.md by removing the 'Introduction', 'Objectives', and 'Challenge Details' sections. More critically, the detailed NVIDIA environment setup script (src/create_env_nvidia.sh) has been removed, and the new READMEs provide insufficient guidance for setting up the necessary environment, which will likely hinder users from running the project.

I am having trouble creating individual review comments. Click here to see my feedback.

openseek/competition/LongContext-ICL-Annotation/README.md (52)

The instruction to create the environment using create_env_nvidia.sh has been removed, which is consistent with the removal of the script itself. However, the English README now completely lacks detailed environment setup instructions, which were previously provided by that script. This will make it very difficult for users to set up the project.

openseek/competition/LongContext-ICL-Annotation/README_cn.md (17-20)

The '环境' (Environment) section lists only openai, torch, and flagScale as dependencies. This is likely insufficient for running the project, especially considering the complexity of the create_env_nvidia.sh script that was removed (which included dependencies like DeepSpeed, FlashAttention, vLLM, etc.). Users will face significant challenges in setting up the environment with such minimal guidance.

openseek/competition/LongContext-ICL-Annotation/src/create_env_nvidia.sh (1-46)

The create_env_nvidia.sh script, which provided comprehensive environment setup instructions including cloning FlagScale, creating a conda environment, and installing various complex dependencies (like torch, deepspeed, transformer_engine, flash_attn, vllm, mamba, FlagGems), has been entirely removed. This removal, without a clear and detailed replacement in either the English or Chinese READMEs, will severely impede users from setting up and running the project. The listed dependencies in the new README_cn.md are far from sufficient.

openseek/competition/LongContext-ICL-Annotation/README.md (12-40)

The removal of the 'Introduction', 'Objectives', and 'Challenge Details' sections from the English README significantly reduces the context and information available to English-speaking participants about the competition's purpose, goals, and rules. While a Chinese README has been added, the English version now lacks crucial details that were previously present. This could make it difficult for non-Chinese speakers to understand the competition fully.