tensorflow / tensorflow/tensorboard

[Markdown Supports] Maths, Python code etc..

Open
#2,904 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core:backend core:frontend theme:ui-polish type:feature
Dominant language
TypeScript
Stars
7.2k
Forks
1.7k
Avg merge
4d 22h
Merged PRs (30d)
1

Description

Hi,

Description

Thank you for providing us this great visualisation tool!!
If possible, I'd like to make a Feature requrest regarding Markdown support on Tensorboard.

Currently, if you run the code below, you would get a super simple plot with a description next to the plot. But, unfortunatelly, Tensorboard doesn't render the text(in the code, description) as I use other Markdown editors, e.g., Typora. So, I'd like to know your thoughts on this feature request.

Sample Code

import tensorflow as tf

tf.compat.v1.enable_eager_execution()
writer = tf.compat.v2.summary.create_file_writer("./tmp/")

description = """

```python
print("hello world")
```

## Table

---

| Tables   |      Are      |  Cool |
|----------|:-------------:|------:|
| col 1 is |  left-aligned | $1600 |
| col 2 is |    centered   |   $12 |
| col 3 is | right-aligned |    $1 |

`sh push.sh`

- asdf
- asd

1. asdf
2. asdf

This is an example of an inline MathJax expression: \\( 2 \times 2 = 4 \\)

$\theta$,

$$
\theta
$$

"""

with writer.as_default():
    with tf.contrib.summary.always_record_summaries():
        tf.compat.v2.summary.scalar(name="sample",
                                    data=tf.constant(1),
                                    step=0,
                                    description=description)


Env

  • OS: Ubuntu 18.04
  • Python: 3.7.4
  • TensorFlow: 1.14.0
  • TensorBoard: 1.14.0

Sorry, since Github tries to render even the text in the python code, it doesn't look organised but I hope you'll get my point...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the supplied Python example with TensorFlow 1.14.0 and TensorBoard 1.14.0 to inspect how the description is currently displayed. Define the rendering scope for fenced Python code, tables, lists, inline math, and display math, then verify that each example renders as intended in TensorBoard.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python, tensorflow
Domain
data-visualization, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.