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

Add libclient-py document #270

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from
Draft

Add libclient-py document #270

wants to merge 23 commits into from

Conversation

mdonaka
Copy link
Collaborator

@mdonaka mdonaka commented Jul 28, 2023

Summary

Add libclient-py document

Purpose

To provide API reference.

Contents

  • Add libclient-py doc
  • Add docstring to all libclient-py code
  • Remove setup.{py|cfg}

Testing Methods Performed

  1. Perform the following in the environment of your choice
$ pip install './packages/client/libclient-py[document]'
$ cd docs/libclient-py
$ make autobuild
  1. Access the following link. http://localhost:8000/

Returns
----------
Result
結果のDataFrame
Copy link
Collaborator

Choose a reason for hiding this comment

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

A little more detail would be nice.
The following examples are not appropriate, but are intended to share an image.

Result
            ShareDataFrame
            Result[i][j] : columns1[i] と columns2[j] の相関係数

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added it. e7838c1
Could you check it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you very much!
Very nice, but one of the column1 in correl is probably a mistake for column2.
Everything else is fine.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

wow! I fixed it. Thanks! 6c231fd
I don't know why the commit is not shown on this page, but I will investigate later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants