.. This file is generated by scripts/render_model_docs.py. Do not edit by hand.

EQTransformer
=============

Overview
--------

``eqtransformer`` is the second earthquake picking baseline in the staged roadmap and shares the synthetic waveform contract used by ``phasenet``.

At a Glance
-----------

.. grid:: 1 2 4 4
   :gutter: 2
   :class-container: catalog-grid

   .. grid-item-card:: Hazard Family
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         Earthquake

      .. container:: catalog-stat-note

         Public catalog grouping used for this model.

   .. grid-item-card:: Maturity
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         Implemented

      .. container:: catalog-stat-note

         Catalog maturity label used on the index page.

   .. grid-item-card:: Tasks
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         1

      .. container:: catalog-stat-note

         Phase Picking

   .. grid-item-card:: Benchmark Family
      :class-card: catalog-stat-card

      .. container:: catalog-stat-value

         :doc:`Earthquake Benchmark </benchmarks/earthquake_benchmark>`

      .. container:: catalog-stat-note

         Primary benchmark-family link used for compatible evaluation coverage.


Description
-----------

``eqtransformer`` is the second earthquake picking baseline in the staged roadmap and shares the synthetic waveform contract used by ``phasenet``.

The PyHazards adapter focuses on the shared picking interface rather than a full reproduction of the original multitask training pipeline.

Benchmark Compatibility
-----------------------

**Primary benchmark family:** :doc:`Earthquake Benchmark </benchmarks/earthquake_benchmark>`

**Mapped benchmark ecosystems:** :doc:`pick-benchmark </benchmarks/pick_benchmark>`

External References
-------------------

**Paper:** `Earthquake Transformer-An attentive deep-learning model for simultaneous earthquake detection and phase picking <https://doi.org/10.1038/s41467-020-17591-w>`_ | **Repo:** `Repository <https://github.com/smousavi05/EQTransformer>`__

Registry Name
-------------

Primary entrypoint: ``eqtransformer``

Supported Tasks
---------------

- Phase Picking

Programmatic Use
----------------

.. code-block:: python

   import torch
   from pyhazards.models import build_model

   model = build_model(name="eqtransformer", task="regression", in_channels=3)
   picks = model(torch.randn(4, 3, 256))
   print(picks.shape)

Notes
-----

- Outputs are P- and S-arrival sample indices.