Giter VIP home page Giter VIP logo

research-1's Introduction

Research Repo

Contains all the Jupyter Notebooks used in our research.

Naming convention:

yyyy-mm-dd_initials_dash-separated-notebook-description Example: 2019-02-22_JFJ_meta-labels.

Guidelines:

General

  • Explore only ONE idea.
  • Notebooks must be independent, no Notebook-chaining!
  • Cells must successfully and correctly execute in order using the "Run all cells" command.
  • A notebook should run "as is" if pulled from Git. That is, notebooks may not depend on files on your local computer.

Style

  • Remove unused or commented out code.
  • Remove empty cells.
  • Remove imports that are not used in the notebook.
  • Code must be PEP8 compliant.
  • Notebooks must not contain duplicate code that exists in another notebook. Rather write a function in a common library.

Figures

  • Label figures: include a title, axes descriptions and legends.
  • Explain the figure.

Ease-of-use

  • Keep it short (~300 lines of code).
  • Cells should be short.
  • Have reasonable cell outputs.
  • Include an abstract, introduction, conclusion and next steps section at the beginning of your notebook. These sections should be written in such a way that, in 3 months from now, it is still clear what the notebook's purpose is without reading any other notebooks.

In The Project

  • Functions in the notebook must have (at least) a one-liner doc string describing that function.
  • Complex functions should have toy examples demonstrating purpose and functionality.
  • Pull requests for a notebook must include an update to the solution_document.md file detailing your findings.

research-1's People

Contributors

jackal08 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.