Skip to content

fix: update docs with Bermuda plots & misc API bug fixes #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 3, 2025

Conversation

cmgoold
Copy link
Contributor

@cmgoold cmgoold commented Jun 3, 2025

Updates the docs to use Bermuda plotting capabilities (currently just shows PNGs), and adds a few quality of life improvements too:

  • Exposes the overwrite argument in model predict methods
  • Exposes the limit query argument in get requests so that list can return all objects.
  • Changes the default recency_decay arg in tail models to 1.0 rather than None.

Copy link
Contributor

@Nathaniel-Haines Nathaniel-Haines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cmgoold this LGTM!

My only potential concern would be if users have >1000 (or whatever the upper limit is, I assume 1000?) objects, in which case the methods could fail? I suppose this is down the line and many users may not encounter it, but we may need to implement some explicit pagination logic if there is indeed an upper limit.

Likely OK to ignore for now though, as it will raise an explicit error if it happens 🤓

@cmgoold
Copy link
Contributor Author

cmgoold commented Jun 3, 2025

@Nathaniel-Haines I'm not sure there is an upper limit? Is that stated anywhere? I would imagine not as the limit argument is just a query parameter to the url.

@KSafran
Copy link
Collaborator

KSafran commented Jun 3, 2025

@Nathaniel-Haines I'm not sure there is an upper limit? Is that stated anywhere? I would imagine not as the limit argument is just a query parameter to the url.

From what I read there is no upper limit, but the query will get slow if we have too many triangles in there. We can revisit once a user has over 1k triangles?

@cmgoold cmgoold merged commit 884731c into main Jun 3, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants