TFX pipeline Local orchestrator documentation site contains several errors/exceptions

[ruan-takealot]

The document covering the usage of the TFX pipeline Local orchestrator currently has many errors/exceptions on it.

URL(s) with the issue:

Please provide a link to the documentation entry, for example:
https://www.tensorflow.org/tfx/tutorials/tfx/template_local
(snapshot at time of issue creation: https://web.archive.org/web/20230930160141/https://www.tensorflow.org/tfx/tutorials/tfx/template_local)

Description of issue (what needs changing):

At the time of issue creation, the text in the output sections of the documentation contains many errors or exception messages.
Examples:

• tensorflow.python.framework.errors_impl.PermissionDeniedError: /content; Permission denied
• /tmpfs/src/tf_docs_env/bin/python: Error while finding module specification for 'models.features_test' (ModuleNotFoundError: No module named 'models')
• Invalid pipeline path: local_runner.py
• (several times) /tmpfs/src/tf_docs_env/bin/python3.9: can't open file '/tmpfs/src/temp/docs/tutorials/tfx/local_runner.py': [Errno 2] No such file or directory. Error while running "/tmpfs/src/tf_docs_env/bin/python3.9 local_runner.py"

Clear description:

The document documenting the usage of the TFX pipeline Local orchestrator currently has many errors/exceptions on it.

Correct links

N/A

Parameters defined

N/A

Returns defined

N/A

Raises listed and defined

N/A

Request visuals, if applicable

[singhniraj08]

@ruan-takealot,

I tried the template_local example in colab environment and it ran successfully without any issues. Ref: Gist

Only error I was able to see was (ModuleNotFoundError: No module named 'models.keras') in the pipeline unit test. Let me debug this and I will update the thread on unit test failure. Apart from that the pipeline runs successfully without any issues.

The permission denied error you are facing is most probably because you may not have permissions to write/read in your working directory. Using sudo to run commands with root privileges or making sure you working directory is correct will resolve this issue. Ref: similar issue tensorflow/issues/6393

Thank you!

[ruan-takealot]

Thanks @singhniraj08. I'm looking forward to seeing the public-facing documentation in a fixed state 🙂

[singhniraj08]

@ruan-takealot,

Above merged PR #6358 should address the issue with unit test cases and I see documentation is also updated. Please try once and let us know if you face any issues. Thank you!

[github-actions]

This issue has been marked stale because it has no recent activity since 7 days. It will be closed if no further activity occurs. Thank you.

[ruan-takealot]

Looks like the public (internet-facing) documentation still contains errors:

Do you (the TFX team) have to run something else after you merged the PR to update the public documentation?

[singhniraj08]

@ruan-takealot,

In which environment are you running the code? I tried running the code in colab environment and it ran without any Permission denied errors. Ref: Gist

If you are seeing the error in colab environment, requesting you to create a github gist, and share the notebook with us for this error. Thank you!

[ruan-takealot]

@singhniraj08
The issue isn't running the code. The issue is the public facing HTML documentation.
Currently, this is what someone who has an internet browser sees on the public documentation:

[ruan-takealot]

I suspect this issue won't be addressed any time soon 😞
There are many TFX HTML documents (not only on this topic) that are full of errors in their cell outputs.