Comments (4)
Specific things we need:
- tips for how to speed up models (e.g., avoid
torch.stack
) - how to work with
plot_representation_error
from plenoptic.
See diataxis for a framework on technical documentation that looks helpful.
from plenoptic.
Here's one potential schema you could use. It borrows fro the diataxis framework but also the structure of core packages like numpy, scipy, etc
- getting started
- installation
- quickstart
- reference
- model requirements
- citation
- reproducibility
- API
- user guide
- basically, everything else: tutorials, how-tos
from plenoptic.
Copying Daniela's relevant comments about schema (from pyOpenSci review) in here as well:
The documentation webpage is confusing and not well organized, but it can be easily improved. A possible organization would be:
->Presentation
-> Introduction
-> Installation
-> Quick start
-> Citation Guide->Modules
-> Metric
-> Simulate
-> Synthesize
-> tools
-> Display and animate functions->Tutorials and examples
-> Eigendistortions
...
-> Reproducing Wand and Simoncelli
-> Extending existing synthesis objects->Advanced Usage
-> Model requirements
-> Synthesis object design
-> Extending...
-> API
-> Tips and tricks
-> ReproducibilityIn the section "Modules" it would be presented the general goal and content of the module and, eventually, some code snap-shots. Not all the modules need to be present, only the most relevant and/or difficult to use. The code snap-shots can be from the tutorials and examples already existing, In addition, there can be links between the modules and tutorial sections
In the section "Tutorials and examples" would be all the tutorials already on the website.
from plenoptic.
Related Issues (20)
- Make Portilla-Simoncelli texture model work on arbitrarily-sized images
- Make Portilla-Simoncelli code more efficient HOT 1
- Improve Portilla-Simoncelli representation plot
- pip install -e . command error HOT 2
- Refactor steerable pyramid
- Rethink plotting code
- Add data/examples folder to plenoptic with functions for accessing HOT 4
- DOC: Add repo status badge to README [pyOS review]
- DOC: Add examples for (most) user-facing functions [pyOpenSci review]
- TST: Test fails locally [pyOpenSci review] HOT 6
- DOC: Clarify what "model" means in README + conceptual introduction [pyOpenSci review]
- DOC: clearly state how to cite in citation section of README and docs, point to citation.cff [pyOpenSci review] HOT 4
- DOC: update metamer tutorial
- problem when installing with jupyter notebook HOT 5
- Implement LNP / GLM model
- Update dependency descriptions
- Fix Zenodo badge on readme HOT 1
- Improve API HOT 4
- Packaging updates
- Precision Error in TestLaplacianPyramid when run on GPU but not on CPU HOT 1
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 plenoptic.