Skip to content
This repository was archived by the owner on Sep 27, 2024. It is now read-only.

Remove docs extra #277

Merged
merged 1 commit into from
May 21, 2023
Merged

Remove docs extra #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 0 additions & 12 deletions model_card_toolkit/dependencies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@
'pytest': 'pytest',
'tensorflow_data_validation': 'tensorflow-data-validation>=1.5.0,<2.0.0',
'tensorflow_datasets': 'tensorflow-datasets>=4.8.2',
'tensorflow_docs':
'tensorflow-docs @ git+https://github.com/tensorflow/docs',
'tensorflow_metadata': 'tensorflow-metadata>=1.5.0,<2.0.0',
'tensorflow_model_analysis': 'tensorflow-model-analysis>=0.36.0,<0.42.0',
'yapf': 'yapf',
Expand All @@ -44,8 +42,6 @@
'protobuf', # working with model card protos
]

_DOCS_EXTRA_DEPS = ['absl', 'tensorflow_docs']

_EXAMPLES_EXTRA_DEPS = [
# Required for model_card_toolkit.documentation.examples.cats_vs_dogs
'tensorflow_datasets',
Expand Down Expand Up @@ -90,11 +86,6 @@ def make_required_install_packages() -> List[str]:
return _make_deps_list(_REQUIRED_DEPS)


def make_extra_packages_docs() -> List[str]:
"""Returns the list of packages needed for building documentation."""
return _make_deps_list(_DOCS_EXTRA_DEPS)


def make_extra_packages_examples() -> List[str]:
"""Returns the list of packages needed for running examples."""
return _make_deps_list(_EXAMPLES_EXTRA_DEPS)
Expand Down Expand Up @@ -122,8 +113,6 @@ def make_extra_packages_test() -> List[str]:
return _make_deps_list(_TEST_EXTRA_DEPS)


# NOTE: Omit `docs` dependencies from `all` since they're not necessary for
# running all tests and to avoid dependency conflicts.
def make_extra_packages_all() -> List[str]:
"""Returns the list of all optional packages."""
return [
Expand All @@ -136,7 +125,6 @@ def make_extra_packages_all() -> List[str]:
def make_required_extra_packages() -> Dict[str, List[str]]:
"""Returns the dict of required extra packages."""
return {
'docs': make_extra_packages_docs(),
Copy link
Member

@casassg casassg May 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

won't this break the TF website generation? Not sure how that is being generated...

Copy link
Contributor Author

@codesue codesue May 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, tensorflow_docs was never listed as a dependency. Here are the dependencies from 1.3: https://github.com/tensorflow/model-card-toolkit/blob/v1.3.0/setup.py#LL31-L42. It's needed to build the docs locally with python tools/build_api_docs.py.

I'm not sure exactly how the docs are being generated for the website yet, e.g. whether internal or tied to a TensorFlow release, but I'm following up on this.

Copy link
Contributor Author

@codesue codesue Jun 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently the docs are built internally at Google in a manual process.

'examples': make_extra_packages_examples(),
'tensorflow': make_extra_packages_tensorflow(),
'test': make_extra_packages_test(),
Expand Down