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.

Sign up for GitHub

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

Jump to bottom

[FLINK-27716] Add Filnk ML Python API docs #201

Merged
merged 1 commit into from
Feb 8, 2023
Merged

[FLINK-27716] Add Filnk ML Python API docs #201

merged 1 commit into from
Feb 8, 2023

Conversation

jiangxin369
Copy link
Contributor

@jiangxin369 jiangxin369 commented Jan 19, 2023 •
edited
Loading

What is the purpose of the change

Add Python API docs in ML. You can generate and view documents on your workstation by the following commands:

  1. cd flink-ml-python/docs
  2. make html
  3. Open the file flink-ml-python/docs/_build/html/index.html in browser.

Brief change log

  • Adds Sphinx config to generate Python API doc automatically.
  • Sets the layout and APIs to be shown.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (no)

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (not applicable)

@jiangxin369 jiangxin369 force-pushed the FLINK-27716 branch 2 times, most recently from 3373be8 to 6a590ad Compare January 20, 2023 02:20
@jiangxin369
Copy link
Contributor Author

@lindong28 Could you help to review this PR?

lindong28
lindong28 reviewed Feb 5, 2023
View reviewed changes
Copy link
Member

@lindong28 lindong28 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Left one comment below.

flink-ml-python/docs/reference/pyflink.ml.core/api.rst Outdated Show resolved Hide resolved
@jiangxin369 jiangxin369 force-pushed the FLINK-27716 branch 3 times, most recently from 2e568f8 to 3900f85 Compare February 7, 2023 14:49
@lindong28
Copy link
Member

Thanks for the update. LGTM.

@lindong28 lindong28 merged commit 76d5b86 into apache:master Feb 8, 2023
@lindong28 lindong28 changed the title [FLINK-27716] Add Python API docs in ML [FLINK-27716] Add Filnk ML Python API docs Feb 8, 2023
vacaly pushed a commit to vacaly/flink-ml that referenced this pull request Feb 10, 2023
@jiangxin369 @vacaly
[FLINK-27716] Add Flink ML Python API docs
cd3dc5f 
This closes apache#201.
Fanoid pushed a commit to Fanoid/flink-ml that referenced this pull request Apr 6, 2023
@jiangxin369 @zhipeng93
[FLINK-27716] Add Flink ML Python API docs
75f3141 
This closes apache#201.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lindong28 lindong28 Awaiting requested review from lindong28

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jiangxin369 @lindong28