tphakala / birdnet-go

Realtime BirdNET soundscape analyzer
Other
135 stars 13 forks source link

feat: add range print command which lists all species included by ran… #203

Closed tphakala closed 2 weeks ago

tphakala commented 2 weeks ago

…ge filter model

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The recent changes introduce and enhance range filtering capabilities in the BirdNET-Go application. The updates include new commands for printing and managing range filters, modifications to the way species scores are handled and displayed, and improvements to the internal logic for determining probable species. These enhancements aim to provide more detailed and user-friendly output for BirdNET range filter results.

Changes

Files Summary
cmd/rangefilter/print.go Introduced PrintCommand for printing BirdNET range filter results and added GetCurrentDateFormatted utility function.
cmd/rangefilter/range.go Added a command for range operations in BirdNET-Go.
cmd/root.go Integrated rangefilter package, created rangeCmd using rangefilter.Command(settings), and added rangeCmd to the root command's subcommands.
internal/analysis/processor/actions.go Updated UpdateRangeFilterAction to extract species labels from species scores and assign them to *a.IncludedSpecies.
internal/analysis/processor/processor.go Modified the New function to convert species scores to species labels before assigning them to *p.IncludedSpecies.
internal/birdnet/birdnet.go Changed getMetaModelData() to use bn.Settings.BirdNET.RangeFilter.Model instead of Version.
internal/birdnet/rangefilter.go Updated GetProbableSpecies to return SpeciesScore structs instead of strings and modified PrintSpeciesScores to print detailed species information.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant RangeFilter
    participant BirdNET
    participant Processor

    User ->> CLI: Execute range command
    CLI ->> RangeFilter: Call Command(settings)
    RangeFilter ->> BirdNET: GetProbableSpecies()
    BirdNET ->> Processor: Return species scores
    Processor ->> RangeFilter: Extract species labels
    RangeFilter ->> CLI: Return range command
    CLI ->> User: Display range results

Poem

In fields where birds sing clear and bright,
New commands take their flight.
Scores and labels, now refined,
BirdNET's wisdom, redefined.
With every chirp and every call,
Range filters guide us all.
🐦✨


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.