Git Product home page Git Product logo

code-packaging's Introduction

Code Packaging and Release

Installation

Please install the following packages:

$ pip install numpy
$ pip install pytest
$ pip install pylint
$ pip install black

or install them with a single line:

$ pip install -r requirements.txt

Linear Regression

A simple linear model can be defined as follows:

$$y = {\boldsymbol \theta}^\top \mathbf{x}.$$

Given $n$ data points and their corresponding noisy evaluations, you can calculate a closed-form solution of ${\boldsymbol \theta}$ solving least squares:

$${\boldsymbol \theta} = (\mathbf{X}^\top \mathbf{X})^{-1} \mathbf{X}^\top \mathbf{y},$$

where $\mathbf{X} \in \mathbb{R}^{n \times d}$ and $\mathbf{y} \in \mathbb{R}^n$.

Code Refactoring

An example is located in src/linear_regression_bad_style.py.

  1. Rename variables.
  2. Make code simple.
  3. Add assertions.
  4. Run pylint.
  5. Run black.
  6. Add unit tests.

Documentation

Run sphinx-build -M html . . in the docs directory.

code-packaging's People

Contributors

jungtaekkim avatar jtkim-lab avatar

Watchers

 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.