Skip to content

Commit 243a9a8

Browse files
committed
Update Readme
1 parent 65da2d9 commit 243a9a8

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ figure, grid, axis, labels = jplt.plot(values,grid_opts,figure_opts,title,(600,
2121
```
2222
and put them on, in or into everwhere you need in 1-2 subsequent lines
2323

24-
- **Flexible**: Control every plot element (figures, grid, axis, labels) and every detail of plotting options independently
24+
- **Flexible**: Control every plot element (figures, grid, axis, labels) and every detail of plotting options independently, all design options are parsed from json-style figure and grid option dicts with full documentation available: https://justpyplot.readthedocs.io/en/latest/
2525

2626
- **No dependencies**: Just vectorized python with numpy(+ other tensor lib you need), which makes standalone and compatible with any use case
2727

@@ -81,9 +81,10 @@ while(cv2.waitKey(1) != 27): # Press ESC to exit
8181

8282
### Overlaying Multiple Plots
8383

84-
And then you take that and overlay, mask, stretch, transform and render at wherever in frame array/canvas/memory you need?
84+
You take to take your plot which you can mask, stretch, transform and render wherever in frame array/canvas/memory you need and just overlay it simpler in one line?
8585

86-
Here I took this concept implementation and stuck it on running mug neural network in 3 lines of code to mess with the detector in physical world (try in examples/mug_objectron/demo.py):
86+
Here 1-liner function implementing those basic steps stuck on running mug neural network.
87+
In 3 lines of code it shows how to mess and visually debug 3d position of computer vision/robotics object in physical world (try in examples/mug_objectron/demo.py):
8788

8889
<p align="center">
8990
<img src="resources/demo.gif" alt="Overlaying multiple plots">
@@ -105,7 +106,7 @@ jplt.plot1_at(image,ang_xs,
105106

106107
### Jupyter Notebook Usage
107108

108-
For jupyter support you can render images anyhow you like the simplest is to use the blend2PIL function depening on Pillow package which will blend all the plot layers into a single PIL image buffer which you can display
109+
For jupyter support you can render images anyhow you like. One of the simplest is to use the blend2PIL function depening on Pillow package which will blend all the plot layers into a single PIL image buffer which you display in notebook
109110

110111
```python
111112
import numpy as np
@@ -137,6 +138,10 @@ display(ipyImage(buffer.getvalue()))
137138
<img src="resources/jupyter_pil.png" alt="Jupyter Plot Output">
138139
</p>
139140

141+
### Documentation
142+
143+
Documentation is fully available at https://justpyplot.readthedocs.io/en/latest/
144+
140145

141146

142147

0 commit comments

Comments
 (0)