lionel/batdetect2
1
0
Fork 0
mirror of https://github.com/macaodha/batdetect2.git synced 2026-05-22 22:32:18 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: update beta release notes and silence noisy warnings

Browse Source
This commit is contained in:
mbsantiago 2026-05-07 08:42:18 +01:00
parent f909da5589
commit f7d481271b
2 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -6,14 +6,19 @@ Code for detecting and classifying bat echolocation calls in high-frequency
audio recordings. audio recordings.
> [!WARNING] > [!WARNING]
> `batdetect2` 2.0.1 is out. > `batdetect2` 2.0.0b1 is out.
> This is a beta release and we are gathering user feedback.
> If you run into issues or have feedback on the new workflows, please use the
> GitHub issues page to let us know.
>
> There are many changes and new recommended workflows. > There are many changes and new recommended workflows.
> We have left the previous `batdetect2.api` module intact, but if you run > We have left the previous `batdetect2.api` module intact, but if you run
> into issues or want to upgrade, see the > into issues or want to upgrade, see the
> [migration guide](docs/source/legacy/migration-guide.md) in the docs site. > [migration guide](docs/source/legacy/migration-guide.md) in the docs site.
> >
> This update also ships with a refreshed default model. > This update also ships with a refreshed default model.
> It was trained in the same way and on the same data as before, but you should still expect small output differences in some cases. > It was trained in the same way and on the same data as before, but you should
> still expect small output differences in some cases.
## What is BatDetect2 ## What is BatDetect2
@ -31,6 +36,10 @@ You can use the tool from the command line (terminal) or from Python as needed.
We have [extensive documentation](docs/source/index.md) on how to use We have [extensive documentation](docs/source/index.md) on how to use
`batdetect2`. `batdetect2`.
The docs site is still being built and will be live soon.
If you want a quick peek for now, see the `docs/` folder in this repository.
See our [getting started](docs/source/getting_started.md) guide and then jump See our [getting started](docs/source/getting_started.md) guide and then jump
into any of our tutorials: into any of our tutorials:

10
src/batdetect2/__init__.py
View File

@ -1,4 +1,5 @@
import logging import logging
import warnings
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
from loguru import logger from loguru import logger
@ -6,15 +7,18 @@ from loguru import logger
if TYPE_CHECKING: if TYPE_CHECKING:
from batdetect2.api_v2 import BatDetect2API from batdetect2.api_v2 import BatDetect2API
__all__ = ["BatDetect2API", "__version__"]
__version__ = "1.1.1"
logger.disable("batdetect2") logger.disable("batdetect2")
# Silences the irrelevant warning
warnings.filterwarnings("ignore", message="The pynvml package is deprecated")
warnings.filterwarnings("ignore", message=".*isinstance(treespec, LeafSpec).*")
numba_logger = logging.getLogger("numba") numba_logger = logging.getLogger("numba")
numba_logger.setLevel(logging.WARNING) numba_logger.setLevel(logging.WARNING)
__all__ = ["BatDetect2API", "__version__"]
__version__ = "1.1.1"
def __getattr__(name: str): def __getattr__(name: str):
if name == "BatDetect2API": if name == "BatDetect2API":