Skip to content

Instantly share code, notes, and snippets.

@ehsan-ami
Created September 6, 2024 16:19
Show Gist options
  • Select an option

  • Save ehsan-ami/85e818273ca6c6e999f839e116e36ce5 to your computer and use it in GitHub Desktop.

Select an option

Save ehsan-ami/85e818273ca6c6e999f839e116e36ce5 to your computer and use it in GitHub Desktop.
README4LLM.md
Follow the general guidelines for every paragraph, follow the specific guidelines for related sections:
######################################################################################################################################
General Guidelines for LLM Editing and Co-writing:
0. Please keep the commented parts untouched
1. Style and Clarity:
- Use common academic writing style with active voice.
- Be clear and concise; avoid ambiguous points.
2. Content Integrity:
- Maintain fidelity to the original text and information.
- Avoid adding extraneous information unless specifically requested.
3. Argumentation:
- Make refutable claims based on the paper's materials.
- Use forward referencing when appropriate.
4. Structure and Coherence:
- Ensure each paragraph serves a clear purpose within the overall narrative.
- Maintain logical connections between preceding and following paragraphs.
- Ensure smooth transitions between sections for a coherent flow.
5. Strengthening Arguments:
- Provide additional points to reinforce key arguments.
- Ensure all claims are well-supported by evidence.
6. Language and Formatting:
- Check for typos, grammatical issues, and punctuation errors.
7. Originality and Attribution:
- Avoid plagiarism by properly attributing sources.
- Distinguish clearly between original and quoted/paraphrased content.
8. Audience Awareness:
- Consider the target audience and adjust language and complexity accordingly.
- Avoid making the audience puzzled, think about explaing material more simpler and clearly
9. Revision Process:
- Avoid making drastic changes without justification; suggest another round of revision if major issues are found.
- For significant changes, explain the reasons and seek permission before proceeding.
10. Paper Structure:
- Maintain the overall structure of the paper (e.g., introduction, methodology, results, discussion).
- Ensure each section fulfills its intended purpose within the paper.
######################################################################################################################################
Specific Guidelines for each section:
0-Abstract:
- Keep it concise (typically 150-250 words for NeurIPS)
- Clearly state the problem being addressed
- Briefly describe your novel approach or methodology
- Highlight key results and their significance
- Mention any important implications or applications
- Use clear, precise language without field-specific jargon
- Avoid citations in the abstract unless absolutely necessary
- Include 1-2 sentences on the broader impact of your work
- End with a strong concluding statement
Structure:
1. Problem statement (1-2 sentences)
2. Approach/methodology (1-2 sentences)
3. Key results (2-3 sentences)
4. Implications and impact (1-2 sentences)
5. Concluding statement (1 sentence)
1-Introduction:
- Engage the reader by clearly explaining the problem's importance and stating key contributions.
- Be precise while avoiding overwhelming details; use motivating examples to illustrate concepts.
- Employ forward referencing for complex topics (e.g., "as explained in Section X").
- Maintain a positive tone, but briefly acknowledge significant limitations if necessary.
- Structure the introduction to include:
a) Problem statement and context
b) Brief overview of existing approaches
c) Clear statement of contributions
- Balance depth and accessibility; aim for clarity without oversimplification.
- Use active voice and concise language to engage the reader.
2-Related works:
- This section should provide context for your work and demonstrate its relevance within the field.
- Present a concise overview of relevant prior research, focusing on works directly related to your study.
- Highlight gaps or limitations in existing literature that your work addresses.
- Organize the review thematically or chronologically, depending on what best suits your narrative.
- Critically analyze key studies, noting their strengths and weaknesses in relation to your work.
- Avoid simply listing citations; instead, synthesize information to show relationships between studies.
- Maintain focus on how previous work informs or contrasts with your research.
- Use clear transitions to guide the reader through different aspects of the literature.
- Conclude by summarizing how your work fits into and advances the existing body of knowledge.
- Remember to keep the narrative specialized for your current work, citing others' contributions without digressing into extensive discussions of tangential research.
3. Problem Definition, Notations, and Background:
- Provide a formal definition of the problem addressed in the paper.
- Introduce and explain all mathematical notations used throughout the work.
- Define key concepts and terminology essential for understanding the methods.
- Present any necessary background information or theoretical foundations.
- Ensure all definitions and notations are precise and unambiguous.
- Structure this section logically, progressing from basic to more complex concepts.
- Use consistent notation throughout the paper to avoid confusion.
- If applicable, include visual aids (e.g., diagrams or equations) to enhance understanding.
4-Methods:
- Provide a clear and detailed description of the research methodology or approach.
- Break down complex procedures into logical steps or subsections.
- Justify your methodological choices and explain their relevance to your research questions.
- Include any assumptions made and their rationale.
- Describe data collection techniques, experimental setup, or analytical tools used.
- If applicable, discuss any limitations of the chosen methods.
- Use diagrams, flowcharts, or pseudocode to illustrate complex processes.
- Ensure reproducibility by providing sufficient detail for others to replicate your work.
- Highlight any novel aspects or modifications to existing methods.
- If relevant, explain how your methods address gaps identified in the literature review.
- Maintain a balance between technical depth and clarity for your target audience.
- Use consistent terminology and notation introduced in previous sections.
5-Experiments and Results:
- Clearly describe your experimental setup, including:
a) Datasets used (size, source, preprocessing steps)
b) Metrics
c) Hyperparameters and their selection process
- Present results in a logical, easy-to-follow manner:
a) Use tables and figures to summarize key findings
b) Include error bars or confidence intervals where appropriate
- Compare your method's performance with relevant baselines and state-of-the-art approaches
- Conduct ablation studies to demonstrate the impact of key components in your method
- Analyze results critically, discussing both strengths and limitations of your approach
- Include qualitative examples or case studies to provide insights into your model's behavior
- Ensure reproducibility by providing details on random seeds, data splits, and evaluation metrics
- Discuss any unexpected findings or challenges encountered during experimentation
- If applicable, include runtime and computational complexity analysis
- Conclude with a brief summary of the key experimental findings and their implications
6-Conclusion:
- Summarize the key contributions and findings of your work concisely.
- Restate the problem addressed and how your approach solves it.
- Highlight the most significant results and their implications for the field.
- Discuss the limitations of your current approach.
- Suggest potential future research directions or extensions of your work.
- Conclude with a broader impact statement, discussing the potential applications or societal implications of your research.
- Keep the conclusion focused and avoid introducing new information.
- Ensure the conclusion aligns with the claims made in the introduction.
- End with a strong closing statement that reinforces the importance of your work.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment