RAIL
eac/introspection

Getting Started

  • Overview
    • A brief note on core DESC software dependencies
    • creation
    • estimation
    • evaluation
  • Installation
    • RAIL packages
      • Installing with pip
      • Installing from source
    • Algorithm / architecture specific issues
      • Installing Delight
      • Installing FZBoost
      • Installing bpz_lite
      • Using GPU-optimization for pzflow
    • Adding your kernel to jupyter
  • Contributing
    • Where to contribute: RAIL packages
      • Contribution workflow
    • Adding a new Rail Stage
    • Adding a new Rail Pipeline
  • Citing RAIL
  • Citing individual codes within RAIL

RAIL Plans

  • Immediate plans
    • 1. Golden Spike: Build the basic infrastructure for controlled experiments of forward-modeled photo-z posteriors
    • 2. RAILroad: Quantify the impact of nonrepresentativity (imbalance and incompleteness) of a training set on estimated photo-z posteriors by multiple machine learning methods
  • Future plans

Usage Demos

  • Core Demo Notebooks
    • Data, files, IO, and RAIL
    • Computing Hyperbolic Magnitudes
    • Iterator Test
    • Pipeline Example
    • Run Pipe
  • Creation Demo Notebooks
    • Using Engines and Degraders to Generate Galaxy Samples with Errors and Biases
    • Grid Selection Degrader to Emulate HSC Training Samples
    • Spectroscopic Selection Degrader to Emulate zCOSMOS Training Samples
    • Using a Creator to Calculate True Posteriors for a Galaxy Sample
  • Estimation Demo Notebooks
    • The NZDir Estimator
    • Testing Sampled Summarizers
  • Other Demo Notebooks
    • Goldenspike, an Example of an End-to-End Analysis Using RAIL

Reference

  • API Documentation
    • rail.core package
      • find_version()
      • Submodules
        • rail.core.algo_utils module
        • rail.core.common_params module
        • rail.core.data module
        • rail.core.introspection module
        • rail.core.stage module
        • rail.core.utilPhotometry module
        • rail.core.utilStages module
        • rail.core.utils module
    • evaluation namespace
      • Subpackages
        • evaluation.metrics namespace
      • Submodules
        • rail.evaluation.evaluator module
        • rail.evaluation.utils module
    • rail.hub package
      • Submodules
    • creation namespace
      • Subpackages
        • creation.degradation namespace
        • creation.engines namespace
      • Submodules
        • creation.degradation namespace
        • rail.creation.degrader module
        • rail.creation.engine module
    • rail.flexzboost package
      • Submodules
    • rail.pipelines package
      • Submodules
        • rail.pipelines.utils.name_factory module
        • rail.pipelines.estimation.inform_all module
    • rail.stages package
      • import_and_attach_all()
      • Submodules
    • rail.gpz package
      • Submodules
    • estimation namespace
      • Subpackages
        • estimation.algos namespace
      • Submodules
        • rail.estimation.estimator module
        • rail.estimation.summarizer module
    • rail.bpz package
      • Submodules
        • rail.bpz.utils module
RAIL
  • rail.pipelines.utils namespace

rail.pipelines.utils namespace

Submodules

  • rail.pipelines.utils.name_factory module
    • CatalogType
      • CatalogType.created
      • CatalogType.degraded
      • CatalogType.reference
    • DataType
      • DataType.catalog
      • DataType.config
      • DataType.metric
      • DataType.model
      • DataType.pdf
    • ModelType
      • ModelType.creator
      • ModelType.degrarder
      • ModelType.estimator
      • ModelType.evaluator
      • ModelType.summarizer
    • NameFactory
      • NameFactory.data_directory_template
      • NameFactory.full_directory_template
      • NameFactory.get_data_dir()
      • NameFactory.get_project_dir()
      • NameFactory.project_directory_template
    • PdfType
      • PdfType.nz
      • PdfType.pz

© Copyright 2019-2021, LSST DESC RAIL Contributors. Revision 5af2f7fb.

Built with Sphinx using a theme provided by Read the Docs.