Source code for seisbench.models.obstransformer

from .eqtransformer import EQTransformer




class OBSTransformer(EQTransformer):
    """
    Initialize an instance of OBSTransformer model.
    OBSTransformer is built based on the original (non-conservative) EqTransformer model.

    .. warning ::

        Creating an OBSTransformer instance does not automatically load the model weights.
        To do so, use `OBSTransformer.from_pretrained("obst2024")`.
    """

    def __init__(
        self,
        lstm_blocks=2,
        drop_rate=0.2,
        original_compatible="non-conservative",
        **kwargs,
    ):
        super().__init__(
            lstm_blocks=lstm_blocks,
            drop_rate=drop_rate,
            original_compatible=original_compatible,
            **kwargs,
        )
        self._citation = (
            "Niksejel, A. and Zhang, M., 2024. OBSTransformer: a deep-learning seismic "
            "phase picker for OBS data using automated labelling and transfer learning. "
            "Geophysical Journal International, p.ggae049, https://doi.org/10.1093/gji/ggae049."
        )