Skip to content

Commit 1743aed

Browse files
authored
Add or remove extra line (#5764)
* Add or remove extra line * Add or remove extra line in md files * Delete extra lines in RELEASE.md * Delete extra lines in colab_integration.md
1 parent 3cb1375 commit 1743aed

8 files changed

+38
-33
lines changed

ADDING_A_PLUGIN.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ The backend and frontend operate within a plugin lifecycle:
3232

3333
- **4) Plugin handles routes**: When a plugin's frontend makes URL requests to its backend, route handlers can respond with collected data.
3434

35-
3635
### Backend: How the plugin processes data, and sends it to the browser
3736

3837
#### Terminology
@@ -72,6 +71,7 @@ class MyPlugin(base_plugin.TBPlugin):
7271
```
7372

7473
#### TBPlugin
74+
7575
- `plugin_name`: Required field used as a unique ID for the plugin. This must only contain alphanumeric characters, hyphens, and underscores.
7676
- `get_plugin_apps()`: This should return a `dict` mapping route paths to WSGI applications: e.g., `"/tags"` might map to `self._serve_tags`.
7777
- `is_active()`: This should return whether the plugin is active (whether there exists relevant data for the plugin to process). TensorBoard will hide inactive plugins from the main navigation bar. We strongly recommend this to be a cheap operation.
@@ -99,14 +99,13 @@ class MyLoader(base_plugin.TBLoader):
9999
```
100100

101101
#### TBLoader
102+
102103
- `define_flags(parser)`: Optional method that takes an argparse.Namespace and exposes command-line flags. Please prefix flags with the name of the plugin to avoid collision.
103104
- `fix_flags(flags)`: Optional method needed to fix or sanitize command-line flags.
104105
- `load(context)`: Required method that takes a TBContext and returns a TBPlugin instance.
105106

106107
It's recommended that plugins using flags call the `parser.add_argument_group(plugin_name)`. To learn more about the flag definition, see [docs](https://docs.python.org/library/argparse.html#adding-arguments)
107108

108-
109-
110109
## Reading data from event files
111110

112111
On instantiation, a plugin is provided a [`PluginEventMultiplexer`] object as a field on the TBContext, from which to read data. The `PluginRunToTagToContent` method on the multiplexer returns a dictionary containing all run–tag pairs and associated summary metadata for your plugin.
@@ -164,7 +163,6 @@ Consistency in user interface and experience, we believe, is important for happy
164163

165164
We recommend that you vendor all resources required to use your plugin, including scripts, stylesheets, fonts, and images. All built-in TensorBoard plugins follow this policy.
166165

167-
168166
### Summaries: How the plugin gets data
169167

170168
Your plugin will need to provide a way for users to log **summaries**, which are the mechanism for getting data from a TensorFlow model to disk and eventually into your TensorBoard plugin for visualization. For example, the example plugin provides a novel [“greeting” TensorFlow op][greeting-op] that writes greeting summaries. A summary is a protocol buffer with the following information:

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ Follow either of the two links above to access the appropriate CLA and instructi
1111

1212
***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
1313

14-
1514
### Working with the team
15+
1616
If you're planning a larger contribution, please get in touch with the team through a GitHub issue before starting work - we can help guide you, and coordinating up front will make the process smoother.
1717

1818
If you want to add a major feature, it may be a good candidate for adding a plugin. Let us know via a GitHub issue, and we can guide you in the process.
1919

2020
### Code reviews
21+
2122
All submissions, including submissions by project members, require review. We
2223
use GitHub pull requests for this purpose.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,6 @@ normal distribution: `[maximum, μ+1.5σ, μ+σ, μ+0.5σ, μ, μ-0.5σ, μ-σ,
195195
minimum]` so that the colored regions, read from inside to outside, have widths
196196
`[σ, 2σ, 3σ]` respectively.
197197

198-
199198
### Image Dashboard
200199

201200
The Image Dashboard can display pngs that were saved via a `tf.summary.image`.

0 commit comments

Comments
 (0)