Adds new pages to tables chapter. #516

katjacksonWB · 2023-12-11T21:01:41Z

Description

Adds two new pages to the tables chapter that describe creating and managing tables.

Ticket

Closes DOCS-803
Related to DOCS-814 (doesn't close)

Checklist

Check if your PR fulfills the following requirements. Put an X in the boxes that apply.

Files I edited were previewed on my local development server with yarn start. My changes did not break the local preview.
Build (yarn docusaurus build) was run locally and successfully without errors or warnings.
I merged the latest changes from main into my feature branch before submitting this PR.

ngrayluna

The main callout is changing the tone from passive to active. I didn't comment on the tables-navigate.md page because I realized that it wasn't constructive to leave the same note for each section.

ngrayluna · 2023-12-12T17:56:40Z

docs/guides/tables/tables-create.md

+
+Unlike traditional spreadsheets, Tables support numerous types of data:
+scalar values, strings, numpy arrays, and most subclasses of `wandb.data_types.Media`.
+This means you can embed `Images`, `Video`, `Audio`, and other sorts of rich, annotated media


Let's break this up into two short sentences.

ngrayluna · 2023-12-12T18:00:57Z

docs/guides/tables/tables-create.md

+This means you can embed `Images`, `Video`, `Audio`, and other sorts of rich, annotated media
+directly in Tables, alongside other traditional scalar values.
+
+Tables can be constructed with initial data using the `data` or


Active voice example: Construct Tables with....

Let's elaborate on what data and dataframe parameters mean. In the code example I don't see a dataframe parameter.

ngrayluna · 2023-12-12T18:01:22Z

docs/guides/tables/tables-create.md

+```
+## Add Data
+
+You can add data to Tables incrementally by using the


Active voice: Add data to Tables incrementally with....."

ngrayluna · 2023-12-12T18:02:22Z

docs/guides/tables/tables-create.md

+wandb.log({"classifier_out": tbl})
+```
+
+Tables added directly to runs as above will produce a corresponding Table Visualizer in the


When referring to code snippets that happened before or after a text, use "proceeding" or "preceding".

Try to avoid using "which". ESL customers have a hard time with that word. Use a lot of "that".

Tables added directly to runs will produce a Table Visualizer in the W&B Workspace. You can use the visualizer to explore and analyze data.

docs/guides/tables/tables-create.md

docs/guides/tables/tables-navigate.md

docs/guides/tables/tables-create.md

ngrayluna · 2024-01-13T00:17:14Z

docs/guides/tables/tables-download.md

@@ -34,7 +34,7 @@ df = table.get_dataframe()
 ```

 ## Export Data
-Now you can export using any method dataframe supports:
+Now, export using any method dataframe supports:


Suggestion: "Now" -> "Next,"

ngrayluna · 2024-01-13T00:17:23Z

docs/guides/tables/tables-navigate.md

+## The W&B platform
+When first opening your workspace, you can see  a simple visualization of your tables. Each table you create appears in a `panel` where you can further customize your data.
+
+There is also a statement on the top of your panel. If you're following one of the example guides, this statement should bevalv `runs.summary["Table Name"]`. You can also edit this statement. 


Spell check

ngrayluna

Some checks left

ngrayluna

Looking good. Looks like there are some style changes to be done to the tables-navigate doc

github-actions · 2024-10-03T19:46:09Z

docs/guides/tables/tables-navigate.md

+displayed_sidebar: default
+---
+
+# Manage Tables


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Manage Tables' should use sentence-style capitalization.

github-actions · 2024-10-03T19:46:09Z

docs/guides/tables/tables-navigate.md

+
+Once you've [created a table](./tables-create.md), you can use the W&B platform to analyze, customize, and manage your data. 
+
+## The W&B Platform


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'The W&B Platform' should use sentence-style capitalization.

github-actions · 2024-10-03T19:46:09Z

docs/guides/tables/tables-navigate.md

+Once you've [created a table](./tables-create.md), you can use the W&B platform to analyze, customize, and manage your data. 
+
+## The W&B Platform
+When you first open your workspace, you will be presented with a simple visualization of your tables. Each table you create appears in a `panel` where you can further customize your data.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Will] Avoid using 'will'.

github-actions · 2024-10-03T19:46:09Z

docs/guides/tables/tables-navigate.md

+Once you've [created a table](./tables-create.md), you can use the W&B platform to analyze, customize, and manage your data. 
+
+## The W&B Platform
+When you first open your workspace, you will be presented with a simple visualization of your tables. Each table you create appears in a `panel` where you can further customize your data.


📝 [vale] _{reported by reviewdog 🐶}
[Google.Passive] In general, use active voice instead of passive voice ('be presented').

github-actions · 2024-10-03T19:46:09Z

docs/guides/tables/tables-navigate.md

+## The W&B Platform
+When you first open your workspace, you will be presented with a simple visualization of your tables. Each table you create appears in a `panel` where you can further customize your data.
+
+You'll also notice a statement at the top of your panel. If you're following one of our example guides, it will look something like `runs.summary["Table Name"]`. You can edit this statement, which will be discussed later. 


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.We] Try to avoid using first-person plural like 'our'.

github-actions · 2024-10-03T19:46:10Z

docs/guides/tables/tables-navigate.md

+- row
+- range
+
+For more information on visualizing tables, see our [full guide](./visualize-tables.md).


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.We] Try to avoid using first-person plural like 'our'.

github-actions · 2024-10-03T19:46:10Z

docs/guides/tables/tables-navigate.md

+
+For more information on visualizing tables, see our [full guide](./visualize-tables.md).
+
+## Export Data


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Export Data' should use sentence-style capitalization.

github-actions · 2024-10-03T19:46:10Z

docs/guides/tables/tables-navigate.md

+## Export Data
+You can easily export your table data to a .csv file by clicking the `Export to CSV` button, usually located at the bottom of a table's panel. Clicking this button automatically downloads a .csv file of your current table, with any formats or editing you have made.
+
+For more methods of exporting data, see our [full guide](./tables-download.md).


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.We] Try to avoid using first-person plural like 'our'.

github-actions · 2024-10-03T19:46:10Z

docs/guides/tables/tables-navigate.md

+
+For more methods of exporting data, see our [full guide](./tables-download.md).
+
+## Next Steps


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Next Steps' should use sentence-style capitalization.

github-actions · 2024-10-03T19:46:10Z

docs/guides/tables/tables-navigate.md

+For more methods of exporting data, see our [full guide](./tables-download.md).
+
+## Next Steps
+For a more in-depth walkthrough of how to use tables, see our [walkthrough](tables-walkthrough.md).


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.We] Try to avoid using first-person plural like 'our'.

github-actions · 2024-10-03T19:46:47Z

Summary

Status	Count
🔍 Total	15
✅ Successful	1
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	14
❓ Unknown	0
🚫 Errors	0
Full Github Actions output

Adds new pages to tables chapter.

0bdff35

katjacksonWB requested a review from a team as a code owner December 11, 2023 21:01

ngrayluna requested changes Dec 12, 2023

View reviewed changes

katjacksonWB and others added 4 commits December 22, 2023 17:14

Language edits.

7498bc4

Passive voice edits

053ea08

Merge branch 'main' into katjackson-createtables

031a5ed

Vale edits

d15ab72

katjacksonWB requested a review from ngrayluna January 12, 2024 20:14

ngrayluna reviewed Jan 13, 2024

View reviewed changes

ngrayluna self-requested a review January 13, 2024 00:17

ngrayluna requested changes Jan 13, 2024

View reviewed changes

Spelling issues.

b7e5504

katjacksonWB requested a review from ngrayluna January 16, 2024 16:05

ngrayluna requested changes Jan 16, 2024

View reviewed changes

Merge branch 'main' into katjackson-createtables

1bb1d2f

johndmulhausen changed the base branch from main to katjackson-tables October 3, 2024 19:44

Merge branch 'katjackson-tables' into katjackson-createtables

101312f

johndmulhausen merged commit c800259 into katjackson-tables Oct 3, 2024
4 of 5 checks passed

johndmulhausen deleted the katjackson-createtables branch October 3, 2024 19:45

johndmulhausen mentioned this pull request Oct 3, 2024

Adds new pages to tables chapter. #484

Closed

3 tasks

github-actions bot reviewed Oct 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds new pages to tables chapter. #516

Adds new pages to tables chapter. #516

katjacksonWB commented Dec 11, 2023 •

edited by jira bot

Loading

ngrayluna left a comment

ngrayluna Dec 12, 2023

ngrayluna Dec 12, 2023

ngrayluna Dec 12, 2023

ngrayluna Dec 12, 2023

ngrayluna Dec 12, 2023

ngrayluna Jan 13, 2024

ngrayluna Jan 13, 2024

ngrayluna left a comment

ngrayluna left a comment

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot Oct 3, 2024

github-actions bot commented Oct 3, 2024


		Once you've [created a table](./tables-create.md), you can use the W&B platform to analyze, customize, and manage your data.

		## The W&B Platform


		For more information on visualizing tables, see our [full guide](./visualize-tables.md).

		## Export Data


		For more methods of exporting data, see our [full guide](./tables-download.md).

		## Next Steps

Adds new pages to tables chapter. #516

Adds new pages to tables chapter. #516

Conversation

katjacksonWB commented Dec 11, 2023 • edited by jira bot Loading

Description

Ticket

Checklist

ngrayluna left a comment

Choose a reason for hiding this comment

ngrayluna Dec 12, 2023

Choose a reason for hiding this comment

ngrayluna Dec 12, 2023

Choose a reason for hiding this comment

ngrayluna Dec 12, 2023

Choose a reason for hiding this comment

ngrayluna Dec 12, 2023

Choose a reason for hiding this comment

ngrayluna Dec 12, 2023

Choose a reason for hiding this comment

ngrayluna Jan 13, 2024

Choose a reason for hiding this comment

ngrayluna Jan 13, 2024

Choose a reason for hiding this comment

ngrayluna left a comment

Choose a reason for hiding this comment

ngrayluna left a comment

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot Oct 3, 2024

Choose a reason for hiding this comment

github-actions bot commented Oct 3, 2024

Summary

katjacksonWB commented Dec 11, 2023 •

edited by jira bot

Loading