# tbsync
[](https://pypi.org/project/tbsync/)
[](https://github.com/deepghs/tbsync/actions?query=workflow%3A%22Code+Test%22)
[](https://github.com/deepghs/tbsync/actions?query=workflow%3A%22Package+Release%22)
[](https://codecov.io/gh/deepghs/tbsync)
[](https://github.com/deepghs/tbsync/stargazers)
[](https://github.com/deepghs/tbsync/network)
[](https://github.com/deepghs/tbsync/issues)
[](https://github.com/deepghs/tbsync/pulls)
[](https://github.com/deepghs/tbsync/graphs/contributors)
[](https://github.com/deepghs/tbsync/blob/master/LICENSE)
Sync tools for tensorboard logs
Here is an [online demo](https://huggingface.co/spaces/narugo/tbsync_demo) of a space build with `tbsync`.
## Installation
You can simply install it with `pip` command line from the official PyPI site.
```shell
pip install tbsync
```
For more information about installation, you can refer
to [Installation](https://deepghs.github.io/tbsync/main/tutorials/installation/index.html).
## Quick Start
### Initialize Huggingface Space
Create a space repository on Hugging Face with the command below to start TensorBoard. Prior to this, you can log in
using `huggingface-cli` or authenticate by setting the `HF_TOKEN` environment variable.
```shell
tbsync init -r myuser/my_hf_space
```
More usage can be viewed with `tbsync init --help`
```text
Usage: tbsync init [OPTIONS]
Initialize huggingface space repository.
Options:
-r, --repository TEXT Repository on huggingface. [required]
-t, --title TEXT Title of the repository, capitalized
repository name will be used if not given.
-e, --emoji TEXT Emoji to use for repository, see emoji
library for details. Random emoji will be
used when not given.
-p, --private Create private repository.
-l, --licence [openrail|bigscience-openrail-m|creativeml-openrail-m|bigscience-bloom-rail-1.0|bigcode-openrail-m|afl-3.0|apache-2.0|artistic-2.0|bsl-1.0|bsd|bsd-2-clause|bsd-3-clause|bsd-3-clause-clear|c-uda|cc|cc0-1.0|cc-by-2.0|cc-by-2.5|cc-by-3.0|cc-by-4.0|cc-by-sa-3.0|cc-by-sa-4.0|cc-by-nc-2.0|cc-by-nc-3.0|cc-by-nc-4.0|cc-by-nd-4.0|cc-by-nc-nd-3.0|cc-by-nc-nd-4.0|cc-by-nc-sa-2.0|cc-by-nc-sa-3.0|cc-by-nc-sa-4.0|cdla-sharing-1.0|cdla-permissive-1.0|cdla-permissive-2.0|wtfpl|ecl-2.0|epl-1.0|epl-2.0|eupl-1.1|agpl-3.0|gfdl|gpl|gpl-2.0|gpl-3.0|lgpl|lgpl-2.1|lgpl-3.0|isc|lppl-1.3c|ms-pl|mit|mpl-2.0|odc-by|odbl|openrail++|osl-3.0|postgresql|ofl-1.1|tii-falcon-llm|ncsa|unlicense|zlib|pddl|lgpl-lr|deepfloyd-if-license|unknown|other]
Licence for repository. [default: mit]
--port INTEGER Port of tensorboard in space. [default:
6006]
-P, --python_version TEXT Version of python to use. [default: 3.8.1]
-T, --tensorboard_version TEXT Version of tensorboard to use.
--from_color [red|yellow|green|blue|indigo|purple|pink|gray]
From color of space block. Random color will
be used when not given.
--to_color [red|yellow|green|blue|indigo|purple|pink|gray]
To color of space block. Random color will
be used when not given.
-h, --help Show this message and exit.
```
### Upload Tensorboard Log To Space
Upload the `tfevents` files from the local TensorBoard log path to the Hugging Face space repository using the command
below. Prior to this, initialize with the `sync init` command.
```shell
tbsync upload -r myuser/my_hf_space -d /path/to/tb/log
```
After the upload is complete, Hugging Face space will be rebuilt. Once the rebuild is finished, the TensorBoard log can
be viewed in the space.
More usage can be viewed with `tbsync sync --help`
```text
Usage: tbsync sync [OPTIONS]
Upload log file to huggingface space repository.
Options:
-r, --repository TEXT Repository on huggingface. [required]
-d, --directory DIRECTORY Directory of tensorboard logs, should contain
'events.out.tfevents' files. [required]
-n, --name TEXT Name of the log directory on space. Directory
name will be used when not given
-A, --anonymous Hide the local machine's name when uploading.
-h, --help Show this message and exit.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/deepghs/tbsync",
"name": "tbsync",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,tensorboard,huggingface",
"author": "narugo1992",
"author_email": "narugo@126.com",
"download_url": "https://files.pythonhosted.org/packages/3b/fd/4839f1076d2aa01eb0df4de2461961a06e83d70d2b29cb19e5b697e3ff2d/tbsync-0.0.1.tar.gz",
"platform": null,
"description": "# tbsync\n\n[](https://pypi.org/project/tbsync/)\n\n\n\n\n[](https://github.com/deepghs/tbsync/actions?query=workflow%3A%22Code+Test%22)\n[](https://github.com/deepghs/tbsync/actions?query=workflow%3A%22Package+Release%22)\n[](https://codecov.io/gh/deepghs/tbsync)\n\n\n[](https://github.com/deepghs/tbsync/stargazers)\n[](https://github.com/deepghs/tbsync/network)\n\n[](https://github.com/deepghs/tbsync/issues)\n[](https://github.com/deepghs/tbsync/pulls)\n[](https://github.com/deepghs/tbsync/graphs/contributors)\n[](https://github.com/deepghs/tbsync/blob/master/LICENSE)\n\nSync tools for tensorboard logs\n\nHere is an [online demo](https://huggingface.co/spaces/narugo/tbsync_demo) of a space build with `tbsync`.\n\n## Installation\n\nYou can simply install it with `pip` command line from the official PyPI site.\n\n```shell\npip install tbsync\n```\n\nFor more information about installation, you can refer\nto [Installation](https://deepghs.github.io/tbsync/main/tutorials/installation/index.html).\n\n## Quick Start\n\n### Initialize Huggingface Space\n\nCreate a space repository on Hugging Face with the command below to start TensorBoard. Prior to this, you can log in\nusing `huggingface-cli` or authenticate by setting the `HF_TOKEN` environment variable.\n\n```shell\ntbsync init -r myuser/my_hf_space\n```\n\nMore usage can be viewed with `tbsync init --help`\n\n```text\nUsage: tbsync init [OPTIONS]\n\n Initialize huggingface space repository.\n\nOptions:\n -r, --repository TEXT Repository on huggingface. [required]\n -t, --title TEXT Title of the repository, capitalized\n repository name will be used if not given.\n -e, --emoji TEXT Emoji to use for repository, see emoji\n library for details. Random emoji will be\n used when not given.\n -p, --private Create private repository.\n -l, --licence [openrail|bigscience-openrail-m|creativeml-openrail-m|bigscience-bloom-rail-1.0|bigcode-openrail-m|afl-3.0|apache-2.0|artistic-2.0|bsl-1.0|bsd|bsd-2-clause|bsd-3-clause|bsd-3-clause-clear|c-uda|cc|cc0-1.0|cc-by-2.0|cc-by-2.5|cc-by-3.0|cc-by-4.0|cc-by-sa-3.0|cc-by-sa-4.0|cc-by-nc-2.0|cc-by-nc-3.0|cc-by-nc-4.0|cc-by-nd-4.0|cc-by-nc-nd-3.0|cc-by-nc-nd-4.0|cc-by-nc-sa-2.0|cc-by-nc-sa-3.0|cc-by-nc-sa-4.0|cdla-sharing-1.0|cdla-permissive-1.0|cdla-permissive-2.0|wtfpl|ecl-2.0|epl-1.0|epl-2.0|eupl-1.1|agpl-3.0|gfdl|gpl|gpl-2.0|gpl-3.0|lgpl|lgpl-2.1|lgpl-3.0|isc|lppl-1.3c|ms-pl|mit|mpl-2.0|odc-by|odbl|openrail++|osl-3.0|postgresql|ofl-1.1|tii-falcon-llm|ncsa|unlicense|zlib|pddl|lgpl-lr|deepfloyd-if-license|unknown|other]\n Licence for repository. [default: mit]\n --port INTEGER Port of tensorboard in space. [default:\n 6006]\n -P, --python_version TEXT Version of python to use. [default: 3.8.1]\n -T, --tensorboard_version TEXT Version of tensorboard to use.\n --from_color [red|yellow|green|blue|indigo|purple|pink|gray]\n From color of space block. Random color will\n be used when not given.\n --to_color [red|yellow|green|blue|indigo|purple|pink|gray]\n To color of space block. Random color will\n be used when not given.\n -h, --help Show this message and exit.\n```\n\n### Upload Tensorboard Log To Space\n\nUpload the `tfevents` files from the local TensorBoard log path to the Hugging Face space repository using the command\nbelow. Prior to this, initialize with the `sync init` command.\n\n```shell\ntbsync upload -r myuser/my_hf_space -d /path/to/tb/log\n\n```\n\nAfter the upload is complete, Hugging Face space will be rebuilt. Once the rebuild is finished, the TensorBoard log can\nbe viewed in the space.\n\nMore usage can be viewed with `tbsync sync --help`\n\n```text\nUsage: tbsync sync [OPTIONS]\n\n Upload log file to huggingface space repository.\n\nOptions:\n -r, --repository TEXT Repository on huggingface. [required]\n -d, --directory DIRECTORY Directory of tensorboard logs, should contain\n 'events.out.tfevents' files. [required]\n -n, --name TEXT Name of the log directory on space. Directory\n name will be used when not given\n -A, --anonymous Hide the local machine's name when uploading.\n -h, --help Show this message and exit.\n```\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Sync tools for tensorboard logs.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/deepghs/tbsync"
},
"split_keywords": [
"python",
"tensorboard",
"huggingface"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a2b1a332ee4a4654b336bc404f78e5c1005ce927a10770156cef29039f638ad",
"md5": "eeab28aec1c3ca7214b613f33398af96",
"sha256": "bfc6bd1161aec301d855bee3f13005fca43697e4de477c1ec2d1152f15473eae"
},
"downloads": -1,
"filename": "tbsync-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eeab28aec1c3ca7214b613f33398af96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14027,
"upload_time": "2023-06-20T13:43:12",
"upload_time_iso_8601": "2023-06-20T13:43:12.309067Z",
"url": "https://files.pythonhosted.org/packages/2a/2b/1a332ee4a4654b336bc404f78e5c1005ce927a10770156cef29039f638ad/tbsync-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bfd4839f1076d2aa01eb0df4de2461961a06e83d70d2b29cb19e5b697e3ff2d",
"md5": "19ed6575e517a6cd0b9dec47cc6af8ed",
"sha256": "a21f4c9e593ce6b75805fb9861dd7d0f25c616aec31896dc3bf37ef317567354"
},
"downloads": -1,
"filename": "tbsync-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "19ed6575e517a6cd0b9dec47cc6af8ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14720,
"upload_time": "2023-06-20T13:43:14",
"upload_time_iso_8601": "2023-06-20T13:43:14.093696Z",
"url": "https://files.pythonhosted.org/packages/3b/fd/4839f1076d2aa01eb0df4de2461961a06e83d70d2b29cb19e5b697e3ff2d/tbsync-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 13:43:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deepghs",
"github_project": "tbsync",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "hbutils",
"specs": [
[
">=",
"0.9.0"
]
]
},
{
"name": "huggingface_hub",
"specs": [
[
">=",
"0.14.0"
]
]
},
{
"name": "tensorboard",
"specs": []
},
{
"name": "click",
"specs": [
[
">=",
"7.0.0"
]
]
},
{
"name": "typing_extensions",
"specs": []
},
{
"name": "emoji",
"specs": []
},
{
"name": "di-toolkit",
"specs": []
}
],
"lcname": "tbsync"
}
JSON
