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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

write tests #5

Open
sixpearls opened this Issue Apr 12, 2019 · 3 comments

Comments

Projects
None yet
2 participants
@sixpearls
Copy link
Owner

sixpearls commented Apr 12, 2019

Where possible, we should capture mathematical properties as much as possible.

interpolating spline should pass through all points
can we define what the coefficients should be from least squares? I guess we could make an interpolating spline and sample it with noise? should we make sure the residual is proportional to the noise standard deviation?

we could verify the boundary conditions are satisfied (correct derivatives are 0).

is profiling part of testing? maybe we could check that the computation scales with dimension, number of points, etc in some way?

@ixjlyons

This comment has been minimized.

Copy link
Collaborator

ixjlyons commented Apr 14, 2019

should we make sure the residual is proportional to the noise standard deviation?

That's a neat idea. Testing various combinations of boundary conditions sounds like a good idea to me too.

Another aspect to test would be just exercising the API, getting expected exceptions with bad inputs, etc.

Profiling scripts could go in a benchmarks/ folder maybe and run for one specific environment in CI or just run manually before releases or something. There could even be a short docs page with some profiling notes and info from running the scripts.

@sixpearls

This comment has been minimized.

Copy link
Owner Author

sixpearls commented Apr 15, 2019

Would the sphinx-gallery thing be a way to include benchmarks in the docs+CI?

Everything else sounds good.

@ixjlyons

This comment has been minimized.

Copy link
Collaborator

ixjlyons commented Apr 15, 2019

Yeah it could. I'm not sure how flexible it is with where the scripts can be placed (i.e. in two different directories) and where they appear in the docs though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.