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

Api documentation update #325

Closed
wants to merge 5 commits into from
Closed

Api documentation update #325

wants to merge 5 commits into from

Conversation

psspavan96
Copy link

@psspavan96 psspavan96 commented Mar 30, 2022 •
edited
Loading

API Documentation Update

/assign @ckadner

@mlx-bot
Copy link
Collaborator

mlx-bot commented Mar 30, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: psspavan96
To complete the pull request process, please assign yhwang after the PR has been reviewed.
You can assign the PR to them by writing /assign @yhwang in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ckadner ckadner requested review from ckadner and removed request for animeshsingh and Tomcli March 30, 2022 20:24
@ckadner ckadner marked this pull request as draft March 30, 2022 20:25
ckadner
ckadner reviewed Mar 30, 2022
View reviewed changes
api/README.md Outdated

kubectl apply -f ./server/mlx-api.yml
The generation of Python code starts from Swagger Spec. The generated code has 2 outputs: the `/api/client` and the `/api/server` packages. There is no static HTML documentation that gets generated. There are also no Python resources with Swagger annotations from which we generate our Swagger spec, instead the Swagger UI will be generated on the fly when the Python server is started. There are however some docs under the client package, but those are in Markdown format which works well when browsing through the Github repo. The `/api/client/docs` contains some examples from which we create the Python scripts in the examples package. Once the server code is generated we need to copy any new API method stubs (if any new) from the `/api/server/swagger_server/controllers` folder to the `/api/server/swagger_server/controllers_impl` folder and actually write the business logic. If existing API method signatures got updated, we need to update the existing controller methods respectively.
Copy link
Member

Choose a reason for hiding this comment

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

I think it would be easier to read if this paragraph is broken into bullet points

Copy link
Author

@psspavan96 psspavan96 Mar 30, 2022 •
edited by ckadner
Loading

Choose a reason for hiding this comment

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

  • The generation of Python code starts from Swagger Spec. The generated code has 2 outputs: the /api/client and the /api/server packages.
  • No static HTML documentation gets generated from Swagger Spec. The Swagger UI will be generated on the fly when the Python server is started. There are some docs under the client package, but those are in Markdown format which works well when browsing through the Github repo.
  • The /api/client/docs contains some examples from which we create the Python scripts in the /api/examples package.
  • Once the server code is generated we need to copy any new API method stubs (if any new) from the /api/server/swagger_server/controllers folder to the /api/server/swagger_server/controllers_impl folder and actually write the business logic. If existing API method signatures got updated, we need to update the existing controller_impl methods respectively.

Copy link
Author

Choose a reason for hiding this comment

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

Is the flow better?

Copy link
Member

Choose a reason for hiding this comment

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

Yup, I just did a small edit in your comment above. Please update the /api/README.md file accordingly

@shanmukha1996
API Codegen Workflow Image
d51e7ce 
Signed-off-by: Pavan Pss <psspavan96@gmail.com>
Signed-off-by: Shanmukha Pavan <shanmukhapavan@Shanmukhas-MacBook-Pro.local>
@shanmukha1996
Update Readme file with MLX API Codegen Workflow
ba39c14 
Signed-off-by: Pavan Pss <psspavan96@gmail.com>
Signed-off-by: Shanmukha Pavan <shanmukhapavan@Shanmukhas-MacBook-Pro.local>
@shanmukha1996
Describe the Functions of MLX API components
0412f58 
Pavan Pss <psspavan96@gmail.com>

Signed-off-by: Shanmukha Pavan <shanmukhapavan@Shanmukhas-MacBook-Pro.local>
@shanmukha1996
Describe the Functions for MLX API Server Components Functions
3251af4 
Signed-off-by: Pavan Pss <psspavan96@gmail.com>
Signed-off-by: Shanmukha Pavan <shanmukhapavan@Shanmukhas-MacBook-Pro.local>
@shanmukha1996
Update README.md
73ea4a9 
Signed-off-by: Pavan Pss <psspavan96@gmail.com>
@ckadner ckadner closed this in fe965be Apr 11, 2022
@ckadner ckadner added the Jump-Start Work items for Jump-Start participants label Jun 2, 2022
mlx-bot-app bot pushed a commit that referenced this pull request Oct 28, 2022
@ckadner @rafvasq
@krishnakumar27 @dependabot @shanmukha1996 @RRM123 @ezinneanne @kiranp2396 @jbusche @JiaxuanYang
Update v0.2.0 branch (#365)
d304ccc 
* Add dev doc links to CONTRIBUTING.md (#312)

Resolves a task from #304

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

* Fixes the references to latest kfctl release (#311)

Resolves a task from #304

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

* Do not verify links in project dependencies (#320)

Resolves #319

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>

* Add navigation and description table of docs (#314)

* Create readme for docs
* Add description table to readme
* Add links to table
* update relative links
* Change documentation to document

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

* Add script to update the docs table  (#317)


Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

* Modified the way sed version is set (#315)

Instead of checking the operating system or shell emulator,
test which version of `sed` is actually installed in the local
environment.

Resolves #301

Signed-off-by: Krishna Kumar <krishnakumar@ibm.com>

* Bump waitress from 2.0.0 to 2.1.1 in /api/server (#321)

Bumps [waitress](https://github.com/Pylons/waitress) from 2.0.0 to 2.1.1.
- [Release notes](https://github.com/Pylons/waitress/releases)
- [Changelog](https://github.com/Pylons/waitress/blob/master/CHANGES.txt)
- [Commits](Pylons/waitress@v2.0.0...v2.1.1)

---
updated-dependencies:
- dependency-name: waitress
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump jupyter-server from 1.13.4 to 1.15.4 in /api/server (#324)

Bumps [jupyter-server](https://github.com/jupyter/jupyter_server) from 1.13.4 to 1.15.4.
- [Release notes](https://github.com/jupyter/jupyter_server/releases)
- [Changelog](https://github.com/jupyter-server/jupyter_server/blob/main/CHANGELOG.md)
- [Commits](jupyter-server/jupyter_server@v1.13.4...v1.15.4)

---
updated-dependencies:
- dependency-name: jupyter-server
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump minimist from 1.2.5 to 1.2.6 in /dashboard/origin-mlx (#326)

Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump notebook from 6.4.8 to 6.4.10 in /api/server (#327)

Bumps [notebook](http://jupyter.org) from 6.4.8 to 6.4.10.

---
updated-dependencies:
- dependency-name: notebook
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update API developer docs (#325)

* Add codegen workflow diagram
* Describe codegen workflow
* Describe API server package modules

Closes #325

Signed-off-by: Pavan Pss <psspavan96@gmail.com>

Co-authored-by: Christian Kadner <ckadner@us.ibm.com>

* Update UI developer docs (#323)

Closes #323

Signed-off-by: RRM123 <rithikmamidi@gmail.com>

* Correct description for make update_doc_table (#329)

Signed-off-by: ezinneanne <onwukaezinneanne@gmail.com>

* Update Kubernetes high version in deployment docs (#318) (#332)

* Add Troubleshooting section
* Limit K8s version for KIND cluster using `--image` flag

Resolves #318

Signed-off-by: Kiran-Patel <kiran.patel@ibm.com>
Signed-off-by: Kiran Patel 104844270+kiranp2396@users.noreply.github.com
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>

Co-authored-by: Kiran-Patel <kiran.patel@ibm.com>
Co-authored-by: Christian Kadner <ckadner@us.ibm.com>

* fix errors in mlx-ui startup (#338)

* Run mlx-ui as non-root user (#339)

Closes #337

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>

* Update MLX setup instructions for KF 1.5 (#346)

* Update MLX setup instructions for KF 1.5

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>

* fix selected assets show up in different menus (#342)

Signed-off-by: Jiaxuan-Yang <jiaxuan.yang@ibm.com>

* Consolidate readme (#356)

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>
Co-authored-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

* Document MLX Models Workshop (#352)

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>

* Add GitHub action to verify doc links (#357)

Signed-off-by: Rafael Vasquez <raf.vasquez@ibm.com>

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Krishna Kumar <krishnakumar@ibm.com>
Signed-off-by: RRM123 <rithikmamidi@gmail.com>
Signed-off-by: ezinneanne <onwukaezinneanne@gmail.com>
Signed-off-by: Jiaxuan-Yang <jiaxuan.yang@ibm.com>
Signed-off-by: Rafael Vasquez <raf.vasquez@ibm.com>
Co-authored-by: Rafael Vasquez <rafael.vasquez@ryerson.ca>
Co-authored-by: Krishna Kumar Ramachandran <krishnakumar@gatech.edu>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Pavan Pss <psspavan96@gmail.com>
Co-authored-by: RRM123 <40575227+rrm123@users.noreply.github.com>
Co-authored-by: Ezinne Anne Emilia <onwukaezinneanne@gmail.com>
Co-authored-by: Kiran Patel <104844270+kiranp2396@users.noreply.github.com>
Co-authored-by: Kiran-Patel <kiran.patel@ibm.com>
Co-authored-by: jbusche <101845348+jbusche@users.noreply.github.com>
Co-authored-by: Joanna <Jiaxuan.Yang@ibm.com>
Co-authored-by: Rafael Vasquez <rafael.vasquez@ryerson.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ckadner ckadner ckadner left review comments

Assignees
No one assigned
Labels
Jump-Start Work items for Jump-Start participants
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@psspavan96 @mlx-bot @ckadner @shanmukha1996