rail_pz_service package

rail_pz_service is a tool-kit to stand up a web service to provide on-the-fly estimates of per-object photometric redshifts.

It consists of several python sub-packages:

rail_pz_service.common: some common utilites such as configuration management.

rail_pz_service.client: a client-side python interface to access a server.

rail_pz_service.db: the database model and some utilities to mangage it.

rail_pz_service.server: the web service and associated routers.

And a few command line tools:

pz-rail-service-client: a client-side CLI to access a server

pz-rail-service-admin: a server-side CLI to manage the underlying database

pz-rail-service-server: the web-server API

pz-rail-service-worker: a worker process to handle request on the server

• rail_pz_service.config
  • Configuration
    • Configuration.asgi
    • Configuration.daemon
    • Configuration.db
    • Configuration.logging
    • Configuration.model_config
    • Configuration.storage
  • config

• rail_pz_service.common package
  • setup_test_area()
  • teardown_test_area()
  • CLI Parameters
    • DictParamType
      • DictParamType.convert()
      • DictParamType.name
    • EnumChoice
      • EnumChoice.convert()
    • OutputEnum
      • OutputEnum.json
      • OutputEnum.yaml
    • PartialOption
  • Exception Classes
    • RAILBadDatasetError
    • RAILBadInputError
    • RAILBadModelError
    • RAILFileNotFoundError
    • RAILIDMismatchError
    • RAILImportError
    • RAILIntegrityError
    • RAILMissingIDError
    • RAILMissingInputError
    • RAILMissingNameError
    • RAILMissingRowCreateInputError
    • RAILRequestError
    • RAILStatementError
• rail_pz_service.models package
  • Algorithm
    • Algorithm.col_names_for_table
    • Algorithm.id
    • Algorithm.model_config
  • CatalogTag
    • CatalogTag.col_names_for_table
    • CatalogTag.id
    • CatalogTag.model_config
  • Dataset
    • Dataset.catalog_tag_id
    • Dataset.col_names_for_table
    • Dataset.id
    • Dataset.model_config
  • DownloadQuery
    • DownloadQuery.filename
    • DownloadQuery.model_config
  • Estimator
    • Estimator.algo_id
    • Estimator.catalog_tag_id
    • Estimator.col_names_for_table
    • Estimator.id
    • Estimator.model_config
    • Estimator.model_id
  • LoadDatasetQuery
    • LoadDatasetQuery.catalog_tag_name
    • LoadDatasetQuery.data
    • LoadDatasetQuery.model_config
    • LoadDatasetQuery.name
    • LoadDatasetQuery.path
  • LoadEstimatorQuery
    • LoadEstimatorQuery.config
    • LoadEstimatorQuery.model_config
    • LoadEstimatorQuery.model_name
    • LoadEstimatorQuery.name
  • LoadModelQuery
    • LoadModelQuery.algo_name
    • LoadModelQuery.catalog_tag_name
    • LoadModelQuery.model_config
    • LoadModelQuery.name
    • LoadModelQuery.path
  • Model
    • Model.algo_id
    • Model.catalog_tag_id
    • Model.col_names_for_table
    • Model.id
    • Model.model_config
  • NameQuery
    • NameQuery.model_config
    • NameQuery.name
  • Request
    • Request.col_names_for_table
    • Request.dataset_id
    • Request.estimator_id
    • Request.id
    • Request.model_config
    • Request.qp_file_path
    • Request.time_created
    • Request.time_finished
    • Request.time_started
  • RequestCreate
    • RequestCreate.dataset_name
    • RequestCreate.estimator_name
    • RequestCreate.model_config
• rail_pz_service.db package
  • Algorithm
    • Algorithm.class_name
    • Algorithm.class_string
    • Algorithm.col_names_for_table
    • Algorithm.estimators_
    • Algorithm.id
    • Algorithm.models_
    • Algorithm.name
    • Algorithm.pydantic_mode_class
  • Base
    • Base.metadata
    • Base.registry
  • Cache
    • Cache.clear()
    • Cache.create_request()
    • Cache.get_algo_class()
    • Cache.get_catalog_tag_class()
    • Cache.get_estimator()
    • Cache.get_qp_dist()
    • Cache.get_qp_file()
    • Cache.load_algorithms_from_rail_env()
    • Cache.load_catalog_tags_from_rail_env()
    • Cache.load_dataset_from_file()
    • Cache.load_dataset_from_values()
    • Cache.load_estimator()
    • Cache.load_model_from_file()
    • Cache.run_request()
    • Cache.shared_cache()
  • CatalogTag
    • CatalogTag.class_name
    • CatalogTag.class_string
    • CatalogTag.col_names_for_table
    • CatalogTag.datasets_
    • CatalogTag.estimators_
    • CatalogTag.id
    • CatalogTag.models_
    • CatalogTag.name
    • CatalogTag.pydantic_mode_class
  • Dataset
    • Dataset.catalog_tag_
    • Dataset.catalog_tag_id
    • Dataset.class_string
    • Dataset.col_names_for_table
    • Dataset.data
    • Dataset.get_create_kwargs()
    • Dataset.id
    • Dataset.n_objects
    • Dataset.name
    • Dataset.path
    • Dataset.pydantic_mode_class
    • Dataset.requests_
    • Dataset.validate_data()
    • Dataset.validate_data_for_path()
  • Estimator
    • Estimator.algo_
    • Estimator.algo_id
    • Estimator.catalog_tag_
    • Estimator.catalog_tag_id
    • Estimator.class_string
    • Estimator.col_names_for_table
    • Estimator.config
    • Estimator.get_create_kwargs()
    • Estimator.id
    • Estimator.model_
    • Estimator.model_id
    • Estimator.name
    • Estimator.pydantic_mode_class
    • Estimator.requests_
  • Model
    • Model.algo_
    • Model.algo_id
    • Model.catalog_tag_
    • Model.catalog_tag_id
    • Model.class_string
    • Model.col_names_for_table
    • Model.estimators_
    • Model.get_create_kwargs()
    • Model.id
    • Model.name
    • Model.path
    • Model.pydantic_mode_class
    • Model.validate_model()
  • Request
    • Request.class_string
    • Request.col_names_for_table
    • Request.dataset_
    • Request.dataset_id
    • Request.estimator_
    • Request.estimator_id
    • Request.get_create_kwargs()
    • Request.get_open_requests()
    • Request.id
    • Request.pydantic_mode_class
    • Request.qp_file_path
    • Request.time_created
    • Request.time_finished
    • Request.time_started
    • Request.user
  • RowMixin
    • RowMixin.class_string
    • RowMixin.create_row()
    • RowMixin.delete_row()
    • RowMixin.get_create_kwargs()
    • RowMixin.get_row()
    • RowMixin.get_row_by_name()
    • RowMixin.get_rows()
    • RowMixin.id
    • RowMixin.name
    • RowMixin.pydantic_mode_class
    • RowMixin.to_model()
    • RowMixin.update_row()
    • RowMixin.update_values()
  • DB Admin CLI
    • rail_pz_service.db.cli package
      • rail_pz_service.db.cli.admin_options module
      • rail_pz_service.db.cli.wrappers module
• rail_pz_service.client
  • ClientConfiguration
    • ClientConfiguration.auth_token
    • ClientConfiguration.cookies
    • ClientConfiguration.model_config
    • ClientConfiguration.service_url
    • ClientConfiguration.timeout
    • ClientConfiguration.validate_cookies()
    • ClientConfiguration.validate_timeout()
  • PZRailAlgorithmClient
    • PZRailAlgorithmClient.client
    • PZRailAlgorithmClient.get_estimators()
    • PZRailAlgorithmClient.get_models()
    • PZRailAlgorithmClient.get_row()
    • PZRailAlgorithmClient.get_row_by_name()
    • PZRailAlgorithmClient.get_rows()
  • PZRailCatalogTagClient
    • PZRailCatalogTagClient.client
    • PZRailCatalogTagClient.get_datasets()
    • PZRailCatalogTagClient.get_estimators()
    • PZRailCatalogTagClient.get_models()
    • PZRailCatalogTagClient.get_row()
    • PZRailCatalogTagClient.get_row_by_name()
    • PZRailCatalogTagClient.get_rows()
  • PZRailClient
    • PZRailClient.client
  • PZRailDatasetClient
    • PZRailDatasetClient.client
    • PZRailDatasetClient.download()
    • PZRailDatasetClient.get_estimators()
    • PZRailDatasetClient.get_models()
    • PZRailDatasetClient.get_requests()
    • PZRailDatasetClient.get_row()
    • PZRailDatasetClient.get_row_by_name()
    • PZRailDatasetClient.get_rows()
  • PZRailEstimatorClient
    • PZRailEstimatorClient.client
    • PZRailEstimatorClient.get_requests()
    • PZRailEstimatorClient.get_row()
    • PZRailEstimatorClient.get_row_by_name()
    • PZRailEstimatorClient.get_rows()
  • PZRailLoadClient
    • PZRailLoadClient.client
    • PZRailLoadClient.dataset()
    • PZRailLoadClient.estimator()
    • PZRailLoadClient.model()
  • PZRailModelClient
    • PZRailModelClient.client
    • PZRailModelClient.download()
    • PZRailModelClient.get_estimators()
    • PZRailModelClient.get_row()
    • PZRailModelClient.get_row_by_name()
    • PZRailModelClient.get_rows()
  • PZRailRequestClient
    • PZRailRequestClient.client
    • PZRailRequestClient.create()
    • PZRailRequestClient.delete()
    • PZRailRequestClient.download()
    • PZRailRequestClient.get_row()
    • PZRailRequestClient.get_row_by_name()
    • PZRailRequestClient.get_rows()
    • PZRailRequestClient.run()
  • Client CLI
    • rail_pz_service.client.cli package
      • rail_pz_service.client.cli.client_options module
      • rail_pz_service.client.cli.wrappers module