Developer’s Guide

• Contributing
  • Ways to contribute
  • Submitting a bug report or a feature request
    • How to make a good bug report
  • Contributing code
    • How to contribute
    • Pull request checklist
      • Continuous Integration (CI)
      • Stalled pull requests
    • Issues for New Contributors
  • Documentation
    • Building the documentation
    • Guidelines for writing documentation
    • Generated documentation on CircleCI
  • Testing and improving test coverage
    • Writing matplotlib related tests
    • Workflow to improve test coverage
    • Issue Tracker Tags
  • Coding guidelines
    • Input validation
    • Random Numbers
    • Deprecation
    • Change the default value of a parameter
    • Python versions supported
  • Code Review Guidelines
  • APIs of scikit-learn objects
    • Different objects
    • Estimators
      • Instantiation
      • Fitting
      • Estimated Attributes
      • Optional Arguments
      • Pairwise Attributes
  • Rolling your own estimator
    • get_params and set_params
    • Parameters and init
    • Cloning
    • Pipeline compatibility
    • Estimator types
    • Specific models
    • Estimator Tags
  • Reading the existing code base
• Developers’ Tips and Tricks
  • Productivity and sanity-preserving tips
    • Viewing the rendered HTML documentation for a pull request
    • Folding and unfolding outdated diffs on pull requests
    • Checking out pull requests as remote-tracking branches
    • Display code coverage in pull requests
    • Useful pytest aliases and flags
    • Standard replies for reviewing
  • Debugging memory errors in Cython with valgrind
• Utilities for Developers
  • Validation Tools
  • Efficient Linear Algebra & Array Operations
  • Efficient Random Sampling
  • Efficient Routines for Sparse Matrices
  • Graph Routines
  • Testing Functions
  • Multiclass and multilabel utility function
  • Helper Functions
  • Hash Functions
  • Warnings and Exceptions
• How to optimize for speed
  • Python, Cython or C/C++?
  • Profiling Python code
  • Memory usage profiling
  • Performance tips for the Cython developer
    • Using OpenMP
  • Profiling compiled extensions
    • Using yep and gperftools
    • Using gprof
    • Using valgrind / callgrind / kcachegrind
      • kcachegrind
  • Multi-core parallelism using joblib.Parallel
  • A simple algorithmic trick: warm restarts
• Advanced installation instructions
  • Installing nightly builds
  • Building from source
    • Dependencies
    • Retrieving the latest code
    • Mac OSX
    • FreeBSD
  • Installing build dependencies
    • Linux
    • Windows
    • Building binary packages and installers
    • Using an alternative compiler
• Maintainer / core-developer information
  • Before a release
    • Preparing a bug-fix-release
  • Making a release
  • The scikit-learn.org web site
  • Travis Cron jobs
  • Experimental features