Comments (14)
Links in the "Getting Started" Notebook are now fixed by commit 68ffd33
from deeplenstronomy.
I won't create a new issue for the test suite since it is already mentioned here :D
from deeplenstronomy.
I would also like to point out that even though the package has excellent docstrings pretty much everywhere, there's no simple way to see what the API looks like. I feel there is a need to have the API Documentation for the same. Which can be easily achieved using sphinx.
from deeplenstronomy.
I've created a docs page to make the docstrings more accessible with commit a960561
https://deepskies.github.io/deeplenstronomy/docs
from deeplenstronomy.
I've linked the docs page in the main readme so that users can easily find it with commit 7d1d0b7
from deeplenstronomy.
@jiwoncpark I'm planning on addressing your comments about the tests in @shreyasbapat 's issue #42 . When you get a chance, could you look over the improvements I've made to the documentation and let me know if you feel like this issue can be closed?
from deeplenstronomy.
@jiwoncpark I've also updated the paper text based on your recommendations with the following commits:
from deeplenstronomy.
The modules distributions and surveys don't have docstrings, it would be good to add them.
from deeplenstronomy.
The modules distributions and surveys don't have docstrings, it would be good to add them.
@pdebuyl The reason I left docstrings out for those modules is they are internal functions, never called by the user. The only reason I included them in the documentation and didn't make them private methods was to provide a quickly accessible list of all possible surveys and distributions.
Given that information, do you think the docstrings are still necessary for those modules?
from deeplenstronomy.
Given that information, do you think the docstrings are still necessary for those modules?
Yes. But a minimal docstring is fine. Else, the only starting point to figure what a function does is its name or the source code, which is as good as not providing their listing.
from deeplenstronomy.
@pdebuyl I've added docstrings to the distributions.py, surveys.py, and check.py modules with commit e906f49 and I've regenerated all the docs pages.
from deeplenstronomy.
@jiwoncpark Can I go ahead and close this issue?
from deeplenstronomy.
LGTM! Yes, please go ahead.
from deeplenstronomy.
Great! Thanks for the review!
from deeplenstronomy.
Related Issues (20)
- Should we add microlensing?
- should we add line-of-sight stuff? HOT 1
- weak lensing combinations with strong lensing?
- profiling for memory and speed
- do we have a unique identifier for each object HOT 1
- add parallelization
- Make it easy to fix values of parameters in a configuration HOT 2
- Run tests during code development HOT 2
- Unbound local error in `make_dataset` HOT 3
- docstring for `make_dataset` is incomplete
- Coolest package: useful during our refactor for structuring code?
- How does one create lensing substructure in a galaxy-scale lens?
- Update code structure according to new diagram HOT 2
- Fixed redshift value in Plane > 1 outputs N-1 images HOT 2
- 'solve_lens_equation'= True fails test_all.py HOT 2
- what are the units of the output images? HOT 1
- Change "master" branch name to "main"
- ccd gain and magnitude zero point are not added into the image HOT 4
- MASS_PROFILE requirement for source galaxy in config file
- Sky brightness inaccurate due to units error HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from deeplenstronomy.