Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Cost function illustrations #276

Open
thorbjornwolf opened this issue Nov 8, 2022 · 1 comment
Open

Docs: Cost function illustrations #276

thorbjornwolf opened this issue Nov 8, 2022 · 1 comment

Comments

@thorbjornwolf
Copy link

Super neat library! The API feels very well-designed 馃ぉ

Reading the documentation, I miss a couple of things.
Another (after #275) is grokking the cost functions.
For me, plots work wonders, so I would love to be presented with a plot of a typical signal they would be useful on.
For instance, I imagine that CostLinear is useful for something like this:
image
I have no clue what the CostCLinear prototypical signal would look like, however 馃槃

Existing work

I see there's something in the Piecewise Gaussian generation page. It takes a little time to grok, but I got it now. I wish for something like this in the Cost function pages, too 馃檹

@deepcharles
Copy link
Owner

Hi,

Thanks for the comment. Indeed, the documentation needs some improvement. I'll be sure to add your suggestion first. Certainly in Section "Gallery of examples".

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

No branches or pull requests

2 participants