tensorflow / tensorflow/tensorboard

Tensorboard dev upload Description does not support markdown

Open
#3,648 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

tbdev
Dominant language
TypeScript
Stars
7.2k
Forks
1.7k
Avg merge
4d 22h
Merged PRs (30d)
1

Description

Subcommand upload option says:

--description DESCRIPTION
                        Experiment description. Markdown format. Max 600
                        characters.
root@bdf3314a3c02:/code/3_tensorboard# tensorboard dev upload -h
usage: tensorboard dev upload [-h] [--helpfull] [--logdir PATH] [--name NAME]
                              [--description DESCRIPTION] [--plugins PLUGINS]

optional arguments:
  -h, --help            show this help message and exit
  --helpfull            show full help message and exit
  --logdir PATH         Directory containing the logs to process
  --name NAME           Title of the experiment. Max 100 characters.
  --description DESCRIPTION
                        Experiment description. Markdown format. Max 600
                        characters.
  --plugins PLUGINS     List of plugins for which data should be uploaded. If
                        unspecified then data will be uploaded for all plugins
                        supported by the server.
tensorboard dev upload --logdir logs --name davidgoortega --description '[google](https://google.com)'

image

tensorboard dev upload --logdir logs --name davidgoortega --description '## hi there'

image

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 behavior with the tensorboard dev upload command using the linked Markdown examples for a link and a heading. Trace the upload description handling and verify that the submitted Markdown is rendered as formatted content rather than displayed literally.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.