Skip to content

Commit

Permalink
docs: signifigant info
Browse files Browse the repository at this point in the history
  • Loading branch information
trigaten committed Nov 2, 2023
1 parent 674db80 commit 18aa89f
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 4 deletions.
41 changes: 38 additions & 3 deletions docs/how_to_research.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,41 @@
=========================
Step-by-Step Research Guide
How to Research
=========================

Introduction
============
It can be difficult to know where to start researching a topic, especially as an undergrad with little or no experience.
I had to figure this out a few years, so let me save you some time :)


The Beginning
=========================

At the beginning of the research process, you want to go broad in your subject. For example, if you are researching Gen AI Security,
you might look up "Generative AI Security review" (or overview), "Generative AI Security survey", and similar terms. If you can find
a review paper, great, read it. If not, start with the most relevant paper, read the abstract/conclusion, then jump to *related work*.
Most papers have a related work section; it discusses papers related to that one in the field.

Use **Google Scholar**/ArXiv/Semantic Scholar


How to Read a Paper
=========================
If you need to understand a technique proposed by a paper (rather than just learn broadly about the field), do this:

I am using the Chain of thought paper as an example: https://arxiv.org/pdf/2201.11903.pdf

- Read the abstract+conclusion
- Read the description of the proposed method/analysis
- Look at any images (usually exclude graphs)
- Skip related work
- Skip experimental setup
- Skip ablations
- Read the conclusion, and perhaps some discussion

You will usually only want to read the sections I said to skip if you *really* need to understand the technique (for example, if you are comparing it to other techniques).

How to keep track of information
==================================================

Do whatever your project lead suggests. The way I keep track of info is by adding the citation to the Overleaf
bibliography file (read the on Overleaf), then writing comments above it as my notes. I try to just started writing in the regular tex
file as soon as I get a decent understanding of the field.
13 changes: 12 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,25 @@
Documentation for the Systematic Prompt Review Project
====================================================

This website contains all the information you need to understand the research process for this project.
This website contains all the information you need to understand the research process for this project. The first three sections
are about how to do research and use LaTeX/Github. The fourth section is an autogenerated API reference for our codebase.
Make sure to write Sphinx-style docstrings (look this up).

Quick Info:

- Github: https://github.com/trigaten/Prompt_Systematic_Review
- Overleaf: DM Sander or sub-team leader
- The plan document: check announcements in slack
- Main contact: [email protected]


.. toctree::
:maxdepth: 2
:caption: Contents:

how_to_research
using_latex
using_github
prompt_systematic_review


Expand Down
22 changes: 22 additions & 0 deletions docs/using_github.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
=========================
Using Git/Github
=========================

Git and Github are important tools for collaborative coding projects. Here's a basic guide:

1. **Git Basics**: Git is a version control system that helps you track changes in your code. You need to have Git installed on your computer. Learn a few commands like `git clone` (to get a copy of the project), `git pull` (to get the latest changes), `git push` (to share your changes), and `git commit` (to save your work).

2. **Github**: Github is a platform where we store our code, which is based on Git.

3. **Cloning a Repository**: To start working on a project, use `git clone https://github.com/trigaten/Prompt_Systematic_Review.git` to bring the project to your computer.

4. **Branches and Pull Requests**: When you want to change something in the project, create a "branch." It's like creating a separate workspace for your ideas. After you're done, you can ask others to review your work by making a "pull request." It's like getting feedback from others before your changes become part of the main project.

5. **Commit Messages**: When you make changes, write clear and simple messages about what you did. Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

If you have any questions, feel free to ask me or your sub-team leader.

For more help, you can check out the Github Help website: [Github Quickstart](https://docs.github.com/en/get-started/quickstart/hello-world).

Note that our Github repo has a CI pipeline, which automatically runs tests, style checks, and more when you request you merge new code.
This helps ensure that broken code does not get merged in.
16 changes: 16 additions & 0 deletions docs/using_latex.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
=========================
Using LaTeX
=========================

LaTeX is a typesetting language commonly used for creating documents with complex formatting, such as research papers
and scientific articles. For our collaborative document editing, we will be using Overleaf, an online LaTeX editor that
allows multiple people to work on a document simultaneously. If you need access to the LaTeX repository for our project,
please don't hesitate to reach out to me or your sub team lead.

Here are some basic formatting tips with LaTeX:

1. **Section Headings**: You can create section headings using LaTeX by starting a line with a series of `#` symbols. The number of `#` symbols determines the section level. For example, `#` is a top-level section, `##` is a subsection, and so on.

2. **Italics and Bold**: To make text italic, you can use `\textit{}` and to make text bold, you can use `\textbf{}`. For example, `\textit{italic text}` and `\textbf{bold text}`.

Learn more here: [Link to LaTeX Documentation](https://www.overleaf.com/learn)

0 comments on commit 18aa89f

Please sign in to comment.