birdnet.geo.models package

Subpackages

• birdnet.geo.inference package
  • Submodules
  • birdnet.geo.inference.configs module
    • InferenceConfig
      • InferenceConfig.model_conf
      • InferenceConfig.processing_conf
    • ModelConfig
      • ModelConfig.backend_kwargs
      • ModelConfig.backend_type
      • ModelConfig.is_custom
      • ModelConfig.n_species
      • ModelConfig.path
      • ModelConfig.species_list
      • ModelConfig.version
    • PredictionConfig
      • PredictionConfig.min_confidence
      • PredictionConfig.validate_min_confidence()
    • ProcessingConfig
      • ProcessingConfig.device
      • ProcessingConfig.half_precision
      • ProcessingConfig.validate_device()
      • ProcessingConfig.validate_half_precision()
    • RunConfig
      • RunConfig.latitude
      • RunConfig.longitude
      • RunConfig.validate_latitude()
      • RunConfig.validate_longitude()
      • RunConfig.validate_week()
      • RunConfig.validate_year_round_aggregation()
      • RunConfig.week
      • RunConfig.year_round_aggregation
  • birdnet.geo.inference.prediction_result module
    • GeoPredictionResult
      • GeoPredictionResult.latitude
      • GeoPredictionResult.longitude
      • GeoPredictionResult.memory_size_MiB
      • GeoPredictionResult.n_species
      • GeoPredictionResult.species_ids
      • GeoPredictionResult.species_list
      • GeoPredictionResult.species_masked
      • GeoPredictionResult.species_probs
      • GeoPredictionResult.to_arrow_table()
      • GeoPredictionResult.to_csv()
      • GeoPredictionResult.to_dataframe()
      • GeoPredictionResult.to_set()
      • GeoPredictionResult.to_structured_array()
      • GeoPredictionResult.to_txt()
      • GeoPredictionResult.week
  • birdnet.geo.inference.session module
    • GeoPredictionSession
      • GeoPredictionSession.run()
    • GeoSessionBase
  • Module contents
• birdnet.geo.models.v2_4 package
  • Submodules
  • birdnet.geo.models.v2_4.model module
    • GeoDownloaderBaseV2_4
      • GeoDownloaderBaseV2_4.AVAILABLE_LANGUAGES
    • GeoModelV2_4
      • GeoModelV2_4.backend_kwargs
      • GeoModelV2_4.backend_type
      • GeoModelV2_4.get_model_type()
      • GeoModelV2_4.get_version()
      • GeoModelV2_4.is_custom_model
      • GeoModelV2_4.load()
      • GeoModelV2_4.load_custom()
      • GeoModelV2_4.model_path
      • GeoModelV2_4.n_species
      • GeoModelV2_4.predict()
      • GeoModelV2_4.predict_session()
      • GeoModelV2_4.species_list
  • birdnet.geo.models.v2_4.pb module
    • GeoPBBackendFP32V2_4
      • GeoPBBackendFP32V2_4.encoding_key()
      • GeoPBBackendFP32V2_4.encoding_signature_name()
      • GeoPBBackendFP32V2_4.input_key()
      • GeoPBBackendFP32V2_4.precision()
      • GeoPBBackendFP32V2_4.prediction_key()
      • GeoPBBackendFP32V2_4.prediction_signature_name()
      • GeoPBBackendFP32V2_4.supports_encoding()
      • GeoPBBackendFP32V2_4.year_round_week_inputs()
    • GeoPBDownloaderV2_4
      • GeoPBDownloaderV2_4.get_model_path_and_labels()
  • birdnet.geo.models.v2_4.tf module
    • GeoTFBackendFP32V2_4
      • GeoTFBackendFP32V2_4.encoding_out_idx()
      • GeoTFBackendFP32V2_4.in_idx()
      • GeoTFBackendFP32V2_4.precision()
      • GeoTFBackendFP32V2_4.prediction_out_idx()
      • GeoTFBackendFP32V2_4.supports_encoding()
      • GeoTFBackendFP32V2_4.year_round_week_inputs()
    • GeoTFDownloaderV2_4
      • GeoTFDownloaderV2_4.get_model_path_and_labels()
  • Module contents
• birdnet.geo.models.v3_0 package
  • Submodules
  • birdnet.geo.models.v3_0.model module
    • GeoDownloaderBaseV3_0
      • GeoDownloaderBaseV3_0.AVAILABLE_LANGUAGES
      • GeoDownloaderBaseV3_0.ensure_labels_available()
      • GeoDownloaderBaseV3_0.get_lang_file()
    • GeoModelV3_0
      • GeoModelV3_0.backend_kwargs
      • GeoModelV3_0.backend_type
      • GeoModelV3_0.get_model_type()
      • GeoModelV3_0.get_version()
      • GeoModelV3_0.is_custom_model
      • GeoModelV3_0.load()
      • GeoModelV3_0.load_custom()
      • GeoModelV3_0.model_path
      • GeoModelV3_0.n_species
      • GeoModelV3_0.predict()
      • GeoModelV3_0.predict_session()
      • GeoModelV3_0.species_list
  • birdnet.geo.models.v3_0.tf module
    • GeoTFBackendFP16V3_0
      • GeoTFBackendFP16V3_0.encoding_out_idx()
      • GeoTFBackendFP16V3_0.in_idx()
      • GeoTFBackendFP16V3_0.load()
      • GeoTFBackendFP16V3_0.precision()
      • GeoTFBackendFP16V3_0.prediction_out_idx()
      • GeoTFBackendFP16V3_0.supports_encoding()
      • GeoTFBackendFP16V3_0.year_round_week_inputs()
    • GeoTFBackendFP32V3_0
      • GeoTFBackendFP32V3_0.encoding_out_idx()
      • GeoTFBackendFP32V3_0.in_idx()
      • GeoTFBackendFP32V3_0.load()
      • GeoTFBackendFP32V3_0.precision()
      • GeoTFBackendFP32V3_0.prediction_out_idx()
      • GeoTFBackendFP32V3_0.supports_encoding()
      • GeoTFBackendFP32V3_0.year_round_week_inputs()
    • GeoTFBackendInt8V3_0
      • GeoTFBackendInt8V3_0.encoding_out_idx()
      • GeoTFBackendInt8V3_0.in_idx()
      • GeoTFBackendInt8V3_0.load()
      • GeoTFBackendInt8V3_0.precision()
      • GeoTFBackendInt8V3_0.prediction_out_idx()
      • GeoTFBackendInt8V3_0.supports_encoding()
      • GeoTFBackendInt8V3_0.year_round_week_inputs()
    • GeoTFDownloaderV3_0
    • check_tf_library_for_v3_0()
    • check_tf_runtime_compatibility_for_v3_0()
  • birdnet.geo.models.v3_0.pb module
    • GeoPBBackendFP32V3_0
      • GeoPBBackendFP32V3_0.encoding_key()
      • GeoPBBackendFP32V3_0.encoding_signature_name()
      • GeoPBBackendFP32V3_0.input_key()
      • GeoPBBackendFP32V3_0.precision()
      • GeoPBBackendFP32V3_0.prediction_key()
      • GeoPBBackendFP32V3_0.prediction_signature_name()
      • GeoPBBackendFP32V3_0.supports_encoding()
      • GeoPBBackendFP32V3_0.year_round_week_inputs()
    • GeoPBDownloaderV3_0
      • GeoPBDownloaderV3_0.get_model_path_and_labels()
  • birdnet.geo.models.v3_0.pt module
    • GeoPTBackendFP32V3_0
      • GeoPTBackendFP32V3_0.encoding_out_idx()
      • GeoPTBackendFP32V3_0.precision()
      • GeoPTBackendFP32V3_0.prediction_needs_sigmoid()
      • GeoPTBackendFP32V3_0.prediction_out_idx()
      • GeoPTBackendFP32V3_0.probe_input_size_samples()
      • GeoPTBackendFP32V3_0.supports_encoding()
      • GeoPTBackendFP32V3_0.year_round_week_inputs()
    • GeoPTDownloaderV3_0
  • birdnet.geo.models.v3_0.onnx module
    • GeoOnnxBackendFP16V3_0
      • GeoOnnxBackendFP16V3_0.encoding_out_idx()
      • GeoOnnxBackendFP16V3_0.precision()
      • GeoOnnxBackendFP16V3_0.prediction_out_idx()
      • GeoOnnxBackendFP16V3_0.probe_input_size_samples()
      • GeoOnnxBackendFP16V3_0.supports_encoding()
      • GeoOnnxBackendFP16V3_0.year_round_week_inputs()
    • GeoOnnxBackendFP32V3_0
      • GeoOnnxBackendFP32V3_0.encoding_out_idx()
      • GeoOnnxBackendFP32V3_0.precision()
      • GeoOnnxBackendFP32V3_0.prediction_out_idx()
      • GeoOnnxBackendFP32V3_0.probe_input_size_samples()
      • GeoOnnxBackendFP32V3_0.supports_encoding()
      • GeoOnnxBackendFP32V3_0.year_round_week_inputs()
    • GeoOnnxDownloaderV3_0
  • Module contents

Submodules

birdnet.geo.models.base module

class birdnet.geo.models.base.GeoModelBase(model_path, species_list, is_custom_model, backend_type, backend_kwargs)

Bases: ModelBase

property backend_kwargs: dict[str, Any]

property backend_type: type[VersionedGeoBackendProtocol]

abstractmethod classmethod get_version()

Return type:

Literal['2.4', '3.0']

classmethod load(model_path, species_list, backend_type, backend_kwargs)

Return type:

Self

classmethod load_custom(model_path, species_list, backend_type, backend_kwargs, check_validity)

Return type:

Self

predict(latitude, longitude, /, *, week=None, year_round_aggregation='max', min_confidence=0.03, half_precision=False, device='CPU')

Return type:

GeoPredictionResult

predict_session(*, min_confidence=0.03, half_precision=False, device='CPU')

Return type:

GeoPredictionSession

Module contents