search

tphakala / birdnet-go

Realtime BirdNET soundscape analyzer
Other
135 stars 13 forks source link

feat: make range filter model selectable between latest and previous … #200

Closed tphakala closed 2 weeks ago

tphakala commented 2 weeks ago

…"legacy" version.

Also introduces a sliglty changed birdnet config layout with new config node birdnet.rangefilter with mode and threshold (renamed from birdnet.locationfilterthreshold) settings

# BirdNET model specific settings
birdnet:
  sensitivity: 1.0      # sigmoid sensitivity, 0.1 to 1.5
  threshold: 0.8        # threshold for prediction confidence to report, 0.0 to 1.0
  overlap: 0.0          # overlap between chunks, 0.0 to 2.9
  threads: 0            # 0 to use all available CPU threads
  locale: en            # language to use for labels
  latitude: 00.000      # latitude of recording location for prediction filtering
  longitude: 00.000     # longitude of recording location for prediction filtering
  rangefilter:
      model: latest     # model to use for range filter: "latest" or "legacy" for previous model
      threshold: 0.01   # rangefilter species occurrence threshold
coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes introduce a new TensorFlow Lite model and refactor the configuration for range filtering in the BirdNET system. Specifically, a new meta model data is added, and the configuration now uses a nested structure for range filtering instead of a single threshold value. The updates also include renaming and restructuring various configuration settings and their default values to enhance clarity and functionality.

Changes

Files Change Summary
internal/birdnet/birdnet.go Added metaModelDataV1, renamed metaModelData to metaModelDataV2, and updated initialization logic.
internal/birdnet/rangefilter.go Refactored LocationFilterThreshold to RangeFilter.Threshold and updated related logic.
internal/conf/config.go Replaced LocationFilterThreshold with a nested RangeFilter struct in Settings.
internal/conf/config.yaml Updated configuration structure to include rangefilter with model and threshold.
internal/conf/defaults.go Modified default settings to use the new rangefilter structure.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Settings
    participant BirdNET
    participant MetaModel

    User->>Settings: Load Configuration
    Settings->>BirdNET: Provide RangeFilter settings
    BirdNET->>MetaModel: Initialize with selected meta model data
    MetaModel-->>BirdNET: Return initialized model
    BirdNET-->>User: Ready to process with new model

Poem

In the code, a change so bright,
New models take their flight.
Filters now with range and grace,
Configurations find their place.
BirdNET sings a clearer tune,
In the software's sunny noon.
🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
xconverge commented 2 weeks ago

Thanks a lot @tphakala !