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

Documentation Followup #6914

Merged
merged 58 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from 53 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
cbb5675
Fix link to tfx mobile
smokestacklightnin Sep 10, 2024
300cdb1
Fix link to Recommenders ranking TFX
smokestacklightnin Sep 10, 2024
c5f3563
Fix github repo name
smokestacklightnin Sep 10, 2024
a3c9d3e
Fix internal link to "Run the pipeline in Dataflow"
smokestacklightnin Sep 10, 2024
60a3dad
Fix code listings
smokestacklightnin Sep 10, 2024
2464ae6
Fix links
smokestacklightnin Sep 10, 2024
f6c04cf
Fix buttons
smokestacklightnin Sep 10, 2024
60eada3
Clean up link
smokestacklightnin Sep 10, 2024
5d08102
Fix images
smokestacklightnin Sep 10, 2024
b829c34
Fix warning
smokestacklightnin Sep 10, 2024
1a26664
Fix name of admonition
smokestacklightnin Sep 10, 2024
250353b
Fix admonitions
smokestacklightnin Sep 10, 2024
cdfb780
Fix broken images
smokestacklightnin Sep 10, 2024
69f7d54
Fix api docs index link
smokestacklightnin Sep 10, 2024
02b8c56
Add notes admonitions to guide index page
smokestacklightnin Sep 10, 2024
98f73ef
Fix note admonitions for "TFX Cloud Solutions"
smokestacklightnin Sep 10, 2024
819a295
Fix notes admoniations for keras page in guide
smokestacklightnin Sep 10, 2024
9f217e8
Fix note admonitions for "Building TFX Pipelines"
smokestacklightnin Sep 10, 2024
6d94eb3
Fix notes admonitions in examplegen guide page
smokestacklightnin Sep 12, 2024
6de0d62
Fix links in examplegen guide page
smokestacklightnin Sep 12, 2024
22fc82d
Add `__init__.py` to help fix link
smokestacklightnin Sep 12, 2024
b1a04a8
Fix note admonition in transform guide page
smokestacklightnin Sep 12, 2024
e1323c9
Fix note admonition for trainer guide page
smokestacklightnin Sep 12, 2024
c0c34c3
Fix note admonition for tuner guide page
smokestacklightnin Sep 12, 2024
87cd42e
Fix note admonition for infravalidator guide page
smokestacklightnin Sep 12, 2024
4a7969e
Fix note admonitions in "Custom Python function components" guide page
smokestacklightnin Sep 12, 2024
c0aadc7
Fix capitalization
smokestacklightnin Sep 12, 2024
3adb4c1
Fix admonitions in cli guide page
smokestacklightnin Sep 12, 2024
a1ed39a
Enable tables and definition lists
smokestacklightnin Sep 12, 2024
a88f513
Command Line Guide: Update definition list and fix admonitions
smokestacklightnin Sep 12, 2024
9f3b7f3
Fix note admonitions for tfdv guide page
smokestacklightnin Sep 12, 2024
c9b4f7f
TFT Best Practices: Minor formatting changes
smokestacklightnin Sep 12, 2024
040235c
Fix table in TFT best practices
smokestacklightnin Sep 12, 2024
ac33b0a
Convert html table to markdown
smokestacklightnin Sep 13, 2024
8e23f66
Formatting fixes to `components` api docs
smokestacklightnin Sep 13, 2024
12b79fc
Fix notes admonitions
smokestacklightnin Sep 13, 2024
51035c3
Fix internal links from tutorials to guide pages
smokestacklightnin Sep 13, 2024
78ae456
Fix broken link
smokestacklightnin Sep 13, 2024
4ac0a6c
Fix formatting and links in `tfx.v1.dsl` API docs
smokestacklightnin Sep 14, 2024
d511e3e
Fix formatting and links for `extensions` submodule
smokestacklightnin Sep 14, 2024
8f3bc05
Fix links and formatting for orchestration submodule
smokestacklightnin Sep 14, 2024
87ba7e8
Fix links and formatting for types submodule
smokestacklightnin Sep 14, 2024
385715d
Fix guide links in components submodule
smokestacklightnin Sep 14, 2024
eab0435
Fix broken internal links
smokestacklightnin Sep 14, 2024
12d3f3e
Fix broken links
smokestacklightnin Sep 15, 2024
ece000c
Fix button formatting in penguin_simple
smokestacklightnin Sep 17, 2024
f618708
Update "open in colab" buttons in every tutorial
peytondmurray Sep 18, 2024
b5a7015
Remove TF logo
peytondmurray Sep 18, 2024
351fcd4
Add "edit on github" button
peytondmurray Sep 18, 2024
cec3ffa
Fix fairness indicators link
peytondmurray Sep 18, 2024
53a34f2
Update guide and tutorials with github-hosted docs links
peytondmurray Sep 18, 2024
d7c3bd1
Show all types for api.v1.utils
peytondmurray Sep 18, 2024
3f296ff
Show all members of `extensions`, `orchestration`, `testing`, `compon…
smokestacklightnin Sep 18, 2024
172c3fe
Remove comment
smokestacklightnin Sep 22, 2024
69f7a53
Fix links
smokestacklightnin Sep 23, 2024
fb8f301
Fix image paths
smokestacklightnin Sep 23, 2024
9358eb5
Copy image files from code source directory into docs directory
smokestacklightnin Sep 23, 2024
8bf8b69
Change copied images to softlinks
smokestacklightnin Sep 23, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cd-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
mkdocs-material-

- name: Install Dependencies
run: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs mkdocs-jupyter mkdocs-caption
run: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs mkdocs-jupyter mkdocs-caption markdown-grid-tables

- name: Deploy to GitHub Pages
run: mkdocs gh-deploy --force
2 changes: 2 additions & 0 deletions docs/api/v1/extensions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Extension

::: tfx.v1.extensions
options:
show_if_no_docstring: true
17 changes: 17 additions & 0 deletions docs/api/v1/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Modules

[components][tfx.v1.components] module: TFX components module.

[dsl][tfx.v1.dsl] module: TFX DSL module.

[extensions][tfx.v1.extensions] module: TFX extensions module.

[orchestration][tfx.v1.orchestration] module: TFX orchestration module.

[proto][tfx.v1.proto] module: TFX proto module.

[testing][tfx.v1.testing] module: Public testing modules for TFX.

[types][tfx.v1.types] module: TFX types module.

[utils][tfx.v1.utils] module: TFX utils module.
3 changes: 3 additions & 0 deletions docs/api/v1/orchestration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Orchestration

::: tfx.v1.orchestration
options:
show_if_no_docstring: true
<!-- show_submodules: true -->
smokestacklightnin marked this conversation as resolved.
Show resolved Hide resolved
17 changes: 0 additions & 17 deletions docs/api/v1/root.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/api/v1/testing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Testing

::: tfx.v1.testing
options:
show_if_no_docstring: true
2 changes: 2 additions & 0 deletions docs/api/v1/utils.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Utils

::: tfx.v1.utils
options:
show_if_no_docstring: true
4 changes: 2 additions & 2 deletions docs/guide/build_local_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ template.
implement a pipeline for tabular data using the TFX standard components. If
you are moving an existing ML workflow into a pipeline, you may need to
revise your code to make full use of
[TFX standard components](index.md#tfx_standard_components). You may also need
[TFX standard components](index.md#tfx-standard-components). You may also need
to create [custom components](understanding_custom_components.md) that
implement features which are unique to your workflow or that are not yet
supported by TFX standard components.
Expand Down Expand Up @@ -198,7 +198,7 @@ without using a template.
features such as data augmentation.

* Learn more about
[standard TFX components](index.md#tfx_standard_components).
[standard TFX components](index.md#tfx-standard-components).
* Learn more about [custom components](understanding_custom_components.md).

1. Create a script file to define your pipeline using the following example.
Expand Down
19 changes: 11 additions & 8 deletions docs/guide/build_tfx_pipeline.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Building TFX pipelines

Note: For a conceptual view of TFX Pipelines, see
[Understanding TFX Pipelines](understanding_tfx_pipelines.md).
!!! Note
For a conceptual view of TFX Pipelines, see
[Understanding TFX Pipelines](understanding_tfx_pipelines.md).

Note: Want to build your first pipeline before you dive into the details? Get
started
[building a pipeline using a template](build_local_pipeline.md#build-a-pipeline-using-a-template).
!!!Note
Want to build your first pipeline before you dive into the details? Get
started
[building a pipeline using a template](build_local_pipeline.md#build-a-pipeline-using-a-template).

## Using the `Pipeline` class

Expand Down Expand Up @@ -61,9 +63,10 @@ statistics. In this example, the instance of `StatisticsGen` must follow

### Task-based dependencies

Note: Using task-based dependencies is typically not recommended. Defining the
execution graph with artifact dependencies lets you take advantage of the
automatic artifact lineage tracking and caching features of TFX.
!!! Note
Using task-based dependencies is typically not recommended. Defining the
execution graph with artifact dependencies lets you take advantage of the
automatic artifact lineage tracking and caching features of TFX.

You can also define task-based dependencies using your component's
[`add_upstream_node` and `add_downstream_node`](https://github.com/tensorflow/tfx/blob/master/tfx/components/base/base_node.py){: .external }
Expand Down
Loading
Loading