Naming conventions and aliasing

astro-informatics / s2scat

Differentiable and GPU accelerated scattering covariance statistics on the sphere

https://astro-informatics.github.io/s2scat/

MIT License

8 stars 1 forks source link

Naming conventions and aliasing #11

Closed jasonmcewen closed 4 months ago

jasonmcewen commented 5 months ago

[x] Let's adopt the standard AI nomenclature of generative models, so let's use generate rather than synthesis.
[x] Remove core directory and just have core functions in s2scat directory.
[x] WIth the current aliasing the documentation doesn't relate to the actual function calls. If a user goes to check the documentation they don't see documentation for the function name they are working with (e.g. scatter).
[x] Do we need to have separate functions for the c backend with a different name? Can't this just be an argument?

CosmoMatt commented 4 months ago

@jasonmcewen currently we have to use different functions for JAX and C backend functions if we want to decorate the JAX functionality with JIT, as we cannot JIT through the C interface in S2FFT at the ground level.

In future if we update S2FFT C backed to support JIT then we can combine these functions, but for the time being this is not possible.

I've opened a PR here to address these changes.

jasonmcewen commented 4 months ago

Ok, makes sense regarding the C interfaces.