Add clustering module to API docs generator

[arovir01]

This PR adds the clustering module to python/core/api and updates build_docs.py to generate the correct API documentation for clustering.

[arovir01]

@alanchiao Could you please review this?

[alanchiao]

@arovir01: take a look at #427, for what would be better.

Afterwards, we should wait until just a bit prior to launch to submit this PR, since it'll otherwise show up the API docs as launched.

If you want to test the actual imports earlier, we can start by submitting a version of this that

1. has all the right changes under core/api
2. under build_docs.py, blacklist everything from the clustering API so that nothing shows up in the API docs.

And then all the colabs can update to their final versions with the import tensorflow_model_optimization as tfmot style imports.

[arovir01]

@arovir01: take a look at #427, for what would be better.

I removed the wildcard import, as suggested. I will leave the rest as it is until we are ready to sumbit this change.

[alanchiao]

Looks good. Could you add the additional CentroidInitialization enum? @Ruomei

Keeping it in the same location (as in tfmot.clustering.keras.CentroidInitialization) seems ok in my opinion.

On the side, noticed that CentroidInitialization doesn't have any API docs. https://www.tensorflow.org/api_docs/python/tf/distribute/ReduceOp as an example.
cluster_weights can instead directly reference the CentroidInitialization class in its docs and people can go to
`CentroidInitialization''s API docs to understand the differences between the three (like the references to tf.keras.layers.Layer in https://www.tensorflow.org/api_docs/python/tf/keras/estimator/model_to_estimator).

[arovir01]

Could you add the additional CentroidInitialization enum?

Done.

On the side, noticed that CentroidInitialization doesn't have any API docs. https://www.tensorflow.org/api_docs/python/tf/distribute/ReduceOp as an example.
cluster_weights can instead directly reference the CentroidInitialization class in its docs and people can go to
`CentroidInitialization''s API docs to understand the differences between the three (like the references to tf.keras.layers.Layer in https://www.tensorflow.org/api_docs/python/tf/keras/estimator/model_to_estimator).

Good point. Will do this in a separate PR, as it is a somewhat distinct piece of work.

[Ruomei]

Thanks! @Áron Virginás-Tar<mailto:notifications@github.com>

…

________________________________ From: Áron Virginás-Tar <notifications@github.com> Sent: 17 July 2020 11:26 To: tensorflow/model-optimization <model-optimization@noreply.github.com> Cc: Ruomei Yan <Ruomei.Yan@arm.com>; Mention <mention@noreply.github.com> Subject: Re: [tensorflow/model-optimization] Add clustering module to API docs generator (#421) Could you add the additional CentroidInitialization enum? Done. On the side, noticed that CentroidInitialization doesn't have any API docs. https://www.tensorflow.org/api_docs/python/tf/distribute/ReduceOp as an example. cluster_weights can instead directly reference the CentroidInitialization class in its docs and people can go to `CentroidInitialization''s API docs to understand the differences between the three (like the references to tf.keras.layers.Layer in https://www.tensorflow.org/api_docs/python/tf/keras/estimator/model_to_estimator). Good point. Will do this in a separate PR, as it is a somewhat distinct piece of work. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#421 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AIUVJCHEZHAH4JKKHW5UN4DR4ARONANCNFSM4NYQYGIA>. IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

[arovir01]

Will do this in a separate PR, as it is a somewhat distinct piece of work.

PR created.

[akarmi]

@alanchiao, can you please review the recent changes?

[alanchiao]

Looks good - though it is missing changes to python/core/api/BUILD.

Documentation is under final review so will go ahead and merge this while making the necessary changes to BUILD.

[arovir01]

it is missing changes to python/core/api/BUILD

Noted. I will add them. Or do we want to do them in a separate change?