Add performance doc
Documentation PR
- [ ] I've seen the
doc/README.mdfile - [ ] This change runs in the current version of Plotly on PyPI and targets the
doc-prodbranch OR it targets themasterbranch - [ ] If this PR modifies the first example in a page or adds a new one, it is a
pxexample if at all possible - [ ] Every new/modified example has a descriptive title and motivating sentence or paragraph
- [ ] Every new/modified example is independently runnable
- [ ] Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized
- [ ] Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
- [ ] The random seed is set if using randomly-generated data in new/modified examples
- [ ] New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
- [ ] Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
- [ ] Imports are
plotly.graph_objects as go/plotly.express as px/plotly.io as pio - [ ] Data frames are always called
df - [ ]
fig = <something>call is high up in each new/modified example (eitherpx.<something>ormake_subplotsorgo.Figure) - [ ] Liberal use is made of
fig.add_*andfig.update_*rather thango.Figure(data=..., layout=...)in every new/modified example - [ ] Specific adders and updaters like
fig.add_shapeandfig.update_xaxesare used instead of bigfig.update_layoutcalls in every new/modified example - [ ]
fig.show()is at the end of each new/modified example - [ ]
plotly.plot()andplotly.iplot()are not used in any new/modified example - [ ] Hex codes for colors are not used in any new/modified example in favour of these nice ones
Code PR
- [ ] I have read through the contributing notes and understand the structure of the package. In particular, if my PR modifies code of
plotly.graph_objects, my modifications concern thecodegenfiles and not generated files. - [ ] I have added tests (if submitting a new feature or correcting a bug) or modified existing tests.
- [ ] For a new feature, I have added documentation examples in an existing or new tutorial notebook (please see the doc checklist as well).
- [ ] I have added a CHANGELOG entry if fixing/changing/adding anything substantial.
- [ ] For a new feature or a change in behaviour, I have updated the relevant docstrings in the code to describe the feature or behaviour (please see the doc checklist as well).
-->
@marthacryan @archmoj could I get your feedback on this first draft? cc @ndrezn
@marthacryan do you have any additional feedback on this one?
Maybe we should rename the file as well to be called performance. Also, it was sort of hard to find the numpy section because the webgl part was so long. I wonder if we could split them into separate pages that are both linked from the performance page? Or is there some kind of table of contents or link that could be added to the top of the doc to make it easy to jump to the section on numpy arrays?
Maybe we should rename the file as well to be called performance. Also, it was sort of hard to find the numpy section because the webgl part was so long. I wonder if we could split them into separate pages that are both linked from the performance page? Or is there some kind of table of contents or link that could be added to the top of the doc to make it easy to jump to the section on numpy arrays?
Thanks @marthacryan. When it is in the docs, there will be sidebar with the TOC:
It's a good point about the Webgl section though. Some of the examples I think could go. Taking a look.