https://github.com/thammegowda/summary

Research Summaries
https://github.com/thammegowda/summary

Last synced: about 1 month ago
JSON representation

Research Summaries

• Host: GitHub
• URL: https://github.com/thammegowda/summary
• Owner: thammegowda
• License: apache-2.0
• Created: 2019-06-08T05:33:15.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-11T21:58:28.000Z (over 1 year ago)
• Last Synced: 2024-04-18T02:58:24.261Z (7 months ago)
• Language: CSS
• Homepage: https://thammegowda.github.io/summary/nmt/
• Size: 360 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Research Summaries

This is a repository hosting the site `Research Summaries`.

The website itself is hosted under `docs` directory.

The rest of the repository hosts tools for generating the site.

`Research Summaries` are 'almost' 'like' survey papers, but these have some degree of informal-ness.

 The summaries are written like a documentary narrated by "me" to "you" personally.

 "Me" can be anyone interested in telling a story (contributions are welcome), and "you" is some

 one interested in exploring the research at high level (first pass) before narrowing down to a list of papers that must be read.

**Motivation:** 

Imagine writing a sci-fi story focused on a topic XYZ. 

Then imagine taking away fiction part away from sci-fi.

This real story has performers (aka authors), organizations, problems, and solutions.

And a narration that is aimed to be more interesting to hear than a survey paper on topic XYZ.

# How to contribute

All contributions - big or small - are welcome! Issues and Pull requests are the way to go.

1. If you detect errors: typos, wrong citation, anchors - please let us know

2. If you find some essential work is not included in the summary - please let us know.

## Setting up

The site is powered by [Jupyter Book](https://jupyter.org/jupyter-book). More info [here](https://jupyter.org/jupyter-book/guide/01_overview.html)

```bash

pip install jupyter-book

```