Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues in create_tuned_model.md #563

Closed
wants to merge 1 commit into from

Conversation

nidhinpd-YML
Copy link

@nidhinpd-YML nidhinpd-YML commented Sep 20, 2024

Description of the change

Updated markdown to add HTML tags to work inside table cells

Motivation

The details especially for training_data was not readable at all. List and sub list all came under a single sentence. Had to check the comments in code to understand what the doc meant.

Type of change

Documentation

Checklist

  • I have performed a self-review of my code.
  • I have added detailed comments to my code where applicable.
  • I have verified that my change does not break existing code.
  • My PR is based on the latest changes of the main branch (if unsure, please run git pull --rebase upstream main).
  • I am familiar with the Google Style Guide for the language I have coded in.
  • I have read through the Contributing Guide and signed the Contributor License Agreement.

Copy link

google-cla bot commented Sep 20, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions bot added status:awaiting review PR awaiting review from a maintainer component:python sdk Issue/PR related to Python SDK labels Sep 20, 2024
@MarkDaoust
Copy link
Collaborator

Hi, thanks for taking the time to send this change.

One problem here is that these files are generated, so regenerating them will revert these changes.

Another problem is that the source code is used to generate these files has inline markdown that we're inserting into the table cells.

So for an actual fix for the GH viewer we need to find a way to convince it to parse markdown inside the HTML table.

Quick testing shows that the easiest thing is to convince it that the table's help is in a markdown block.

  • Start with a non-breaking space (the line doesn't start with html -> must be Markdown)
  • Don't put line breaks between HTML elements (lines all start with markdown.)
 <table class="responsive fixed orange"><tr><td>`training_data`<a id="training_data"></a></td><td>The dataset to tune the `model on`. 
 
 * This must be either</td></tr></tr></table>

This fix would need to go into the tensoprflow_docs tool we're using here.

@MarkDaoust
Copy link
Collaborator

This is fixed by: #602

@github-actions github-actions bot removed the status:awaiting review PR awaiting review from a maintainer label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:python sdk Issue/PR related to Python SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants