dvc-render is a library for rendering data stored in DVC plots format into different output formats, like Vega. It can also generate HTML and MarkDown reports containing multiple plots.
It is used internally by DVC, DVCLive, and Studio.
Features
Renderers
Take data stored in DVC plots format alongside plot properties in order to render a plot in different formats.
Reports
Take multiple renderers and build an HTML or MarkDown report.
Templates
Support for rendering Vega plots using custom of pre-defined templates.
Requirements
The basic usage of rendering Vega Plots doesn’t have any dependencies outside Python>=3.8.
Additional features are specified as optional requirements:
Installation
You can install DVC render via pip from PyPI:
$ pip install dvc-renderUsage
Renderer & Templates
from dvc_render import VegaRenderer
properties = {"template": "confusion", "x": "predicted", "y": "actual"}
datapoints = [
{"predicted": "B", "actual": "A"},
{"predicted": "A", "actual": "A"},
]
renderer = VegaRenderer(datapoints, "foo", **properties)
plot_content = renderer.get_filled_template()plot_content contains a valid Vega plot using the confusion matrix template.
Report
from dvc_render import render_html
render_html([renderer], "report.html")Contributing
Contributions are very welcome. To learn more, see the Contributor Guide.
License
Distributed under the terms of the Apache 2.0 license, DVC render is free and open source software.
Issues
If you encounter any problems, please file an issue along with a detailed description.
2 maintainers
Metadata
2 maintainers
Release files for dvc-render 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dvc-render-1.0.2.tar.gz | 37.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dvc_render-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 59.8 kB
Release files / dvc-render-1.0.2.tar.gz
| Download URL | dvc-render-1.0.2.tar.gz |
|---|---|
| Size | 37.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40d1cd81760daf34b48fa8362b5002fcbe415e3cdbcf42369b6347d01497ffc0
|
|
BLAKE2b-256 checksum How to use checksums |
be15605312dbdc0931547987ee25a9a3f6fcabf48ca1436039abcd524156b8e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Release files / dvc_render-1.0.2-py3-none-any.whl
| Download URL | dvc_render-1.0.2-py3-none-any.whl |
|---|---|
| Size | 22.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7e3e3cec1200fda41a99984190f14871f3cb878db7f94c853305056f69614ddb
|
|
BLAKE2b-256 checksum How to use checksums |
25e4d79fe332346a47b5468751292c0e45e496e10441e548ef447df1b6adb018
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
