Skip to content

Commit

Permalink
Version 0.2.0 (#54)
Browse files Browse the repository at this point in the history
This updates the documentation.
  • Loading branch information
kimikage authored Dec 11, 2020
1 parent c4f397a commit 3246b53
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "ProfileSVG"
uuid = "132c30aa-f267-4189-9183-c8a63c7e05e6"
version = "0.1.3"
version = "0.2.0"

[deps]
Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@
## Purpose

ProfileSVG allows you to export profiling data as an SVG file.
It can be used to display profiling results in Jupyter/IJulia notebooks,
although the [ProfileVega](https://github.com/davidanthoff/ProfileVega.jl)
package is recommended as a better-maintained viewer for Jupyter notebooks.
It can be used to display profiling results in
Jupyter/[IJulia](https://github.com/JuliaLang/IJulia.jl) notebooks,
[Pluto](https://github.com/fonsp/Pluto.jl) or any other SVG viewer.

An alternative visualization package is the GTK-based
[ProfileView](https://github.com/timholy/ProfileView.jl).
That package offers more interactive features.
See the [documentation](https://kimikage.github.io/ProfileSVG.jl/dev/#Other-tools-for-displaying-profiles) for other visualization tools.

ProfileSVG is essentially just an "export" package built on top of
ProfileSVG is a package built on top of
[FlameGraphs](https://github.com/timholy/FlameGraphs.jl).
Among the Julia packages, ProfileView currently has the most comprehensive
tutorial on how to interpret a flame graph.
Expand Down
23 changes: 17 additions & 6 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ProfileSVG allows you to export profiling data as an SVG file. It can be used to
display profiling results in Jupyter/[IJulia](https://github.com/JuliaLang/IJulia.jl)
notebooks, [Juno](https://junolab.org/) or any other SVG viewer.
notebooks, [Pluto](https://github.com/fonsp/Pluto.jl) or any other SVG viewer.

## Installation
The package can be installed with the Julia package manager. Run:
Expand Down Expand Up @@ -63,6 +63,14 @@ ProfileSVG.view()
If you've already collected profiling data with `@profile`, or if you want to
customize the output, you can call [`ProfileSVG.view`](@ref) directly.

!!! info "Using ProfileSVG within VSCode"
VS Code with Julia Extension has a
[profile viewing feature](https://www.julia-vscode.org/docs/stable/release-notes/v0_17/#Profile-viewing-support-1).
On the other hand, you can also display the SVG output of ProfileSVG in the
Plot Pane in VS Code. Since `@profview` has a name collision with the
Julia extension for VS Code, you need to explicitly specify
[`ProfileSVG.@profview`](@ref) or use [`ProfileSVG.view`](@ref).

### Exporting to SVG file

Even if you don't use graphical front-ends such as Jupyter, you might want to
Expand All @@ -85,11 +93,14 @@ loading the SVG image from an HTML `<img>` element (as above), the interactive
features are usually disabled.

## Other tools for displaying profiles
- [ProfileView](https://github.com/timholy/ProfileView.jl), a graphical user
interface (GUI) based on [Gtk](https://github.com/JuliaGraphics/Gtk.jl).
- VS Code with [Julia extension](https://www.julia-vscode.org/), a development
environment, which supports
[profile visualization](https://www.julia-vscode.org/docs/stable/release-notes/v0_17/#Profile-viewing-support-1).
- [PProf](https://github.com/JuliaPerf/PProf.jl), a web-based profile GUI
explorer, implemented as a wrapper around
[google/pprof](https://github.com/google/pprof).
- [ProfileView](https://github.com/timholy/ProfileView.jl), a GUI based on
[Gtk](https://github.com/JuliaGraphics/Gtk.jl).
- [ProfileVega](https://github.com/davidanthoff/ProfileVega.jl), a
[Vega-Lite](https://vega.github.io/vega-lite/) front-end, which supports
exporting profiling data as a Vega-Lite figure.
- [Juno](https://junolab.org/), a development environment, which supports
[profile visualization](http://docs.junolab.org/stable/man/juno_frontend/#Profiler-1)
as an "in-editor" chart.
Binary file modified images/jupyter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

2 comments on commit 3246b53

@kimikage
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/26222

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.0 -m "<description of version>" 3246b5306defc1adb0379d6655bcbe799fef36c8
git push origin v0.2.0

Please sign in to comment.