Commit Graph

49 Commits

Author SHA1 Message Date
Connor McCarthy b6c660853e
chore(sdk): release KFP SDK 2.0.0-rc.2 (#9605)
* release 2.0.0-rc.2

* update comment
2023-06-09 10:59:05 -07:00
Connor McCarthy 9bce215893
docs(sdk): update dropdown for v1 KFP SDK versions (#9445) 2023-05-17 17:11:06 +00:00
Connor McCarthy 83f6598241
docs(sdk): fix branch tag in dropdown (#9436) 2023-05-16 12:31:09 -07:00
Connor McCarthy f264f38ade
normalize docs version dropdown format (#9435) 2023-05-16 11:56:30 -07:00
Connor McCarthy 209df547ef
chore(sdk): release KFP SDK 2.0.0-rc.1 (#9429) 2023-05-16 18:23:00 +00:00
Chen Sun 3ad91a9bbe
chore: release KFP SDK 2.0.0-beta.17 (#9355)
* Release KFP SDK 2.0.0-beta.17

* update release note
2023-05-08 17:42:55 +00:00
Connor McCarthy 58ebd202c4
release 2.0.0b16 (#9325) 2023-05-04 10:56:24 -07:00
Connor McCarthy 04306dc3cb
chore(sdk): release KFP SDK 2.0.0b15 (#9218) 2023-04-24 18:32:43 +00:00
Chen Sun a107fb1bcf
chore: release SDK 2.0.0b14 (#9144)
* release SDK 2.0.0b14

* doc ref
2023-04-12 14:29:29 -07:00
Connor McCarthy 3428ff9a5f
docs(sdk): add KFP SDK 1.8.20 reference docs (#9067) 2023-04-10 18:46:54 +00:00
Connor McCarthy 86554be46a
release kfp sdk 2.0.b13 (#8904) 2023-02-27 16:52:53 -08:00
Connor McCarthy 893a6e4605
add 1.8.19 docs (#8866) 2023-02-17 11:08:10 -08:00
Chen Sun 0fc174ae28
chore(sdk): release KFP SDK 2.0.0b12 (#8823) 2023-02-08 09:46:17 -08:00
Connor McCarthy 8f472d9872
remove 2.0.0b10 docs (#8746) 2023-01-20 13:12:57 -08:00
Connor McCarthy edfb267790
bump version; update release notes; add docs (#8745) 2023-01-20 12:56:56 -08:00
Connor McCarthy fdf3ee7b68
chore(sdk): release KFP SDK 2.0.0b10 (#8638)
* bump version

* update release notes

* add docs version
2022-12-29 18:05:36 -05:00
Connor McCarthy 579a02ca0d
add versions to docs (#8613) 2022-12-20 18:35:49 -08:00
Connor McCarthy acd3113454
chore(sdk): add KFP SDK 1.8.17 to docs dropdown (#8550) 2022-12-12 19:09:32 +00:00
Connor McCarthy 249e7af384
chore(sdk): release KFP SDK 2.0.0b8 (#8508)
* update release notes

* bump version

* add beta 8 to docs; remove beta 7
2022-11-30 05:04:15 +00:00
Connor McCarthy 1043a88842
chore(sdk): release KFP SDK 2.0.0b7 (#8503)
* update release notes

* bump version

* add docs version to dropdown
2022-11-28 22:58:42 +00:00
Connor McCarthy 9adc7b7526
docs(sdk): add released versions to version dropdown (#8479) 2022-11-23 00:15:42 +00:00
Connor McCarthy 30669e46dc
chore(sdk): improve KFP SDK reference documentation (#8337)
* use autodoc default options

* sort symbol order by typical usage patterns

* include summary of submodule symbols

* expose Input[] and Output[] type generics

* include tables of contents on API reference docs pages

* expand global TOC for discoverability

* fix missing reference / circular import problem
2022-10-17 19:58:53 +00:00
Connor McCarthy 19b8709ca3
chore(release): release sdk 2.0.0b5 (#8309)
* bump reference docs

* update release notes; modify structure

* bump version

* implement review feedback
2022-09-26 21:38:35 +00:00
Connor McCarthy a13ad4e6ae
fix(sdk): fix docs version reference (#8239) 2022-09-02 23:28:13 +00:00
Connor McCarthy 19cf904bc4
feat(docs): use new sdk reference docs theme (#8212)
* use sphinx immaterial

* update css
2022-09-02 22:36:13 +00:00
Connor McCarthy e47a784035
docs(sdk): clean up kfp v2 cli reference docs (#8115)
* use expanded "Command Line Interface" for title

* remove alpha feature stage in help text

* hide deprecated argument

* use compile as command name
2022-08-09 18:40:39 +00:00
Connor McCarthy c6a5e387dd
docs(sdk): refresh SDK public API docstrings (#8057)
* add module-level docstrings

* update compiler docstrings

* update registry module docstrings

* add BaseComponent and children to public api, but discourage use

* update artifact docstrings and type annotations

* update dsl docstrings

* update client docstrings

* clean up kfp.__init__

* add dsl placeholder docstrings

* many more docstring updates

* document type aliases in dsl module
2022-07-21 19:51:18 +00:00
Connor McCarthy 777c98153d
fix(sdk): fixes requirements.txt discovery for sdk api reference docs (#8048) 2022-07-20 22:57:17 +00:00
Connor McCarthy d8b9439ef9
add kfp v2 api reference docs (#8042)
* use __all__ in top-level modules to record public api

* add index and source files

* add kubeflow assets to _static/

* add and pin requirements

* use block quote instead of header for readme notice

* update conf.py

* delete old files
2022-07-19 15:53:54 -06:00
Alexey Volkov cc83e1089b
Assigned copyright to the project authors (#5587) 2021-05-05 13:53:22 +08:00
Rui Fang 518b8b886d
[Doc] update docs that still refer to KFP latest SDK reference (#4845)
* Initial execution cache

This commit adds initial execution cache service. Including http service
and execution key generation.

* fix master

* fix go.sum

* update docs that still refer to KFP latest SDK reference
2020-12-02 20:02:59 -08:00
Yuan (Bob) Gong 898dff3732
doc: versioning policy and feature stages docs. Part of #4533 (#4210)
* doc: versioning policy doc revamp by Bobgy

* update

* update

* update

* update

* rename to feature stages, add links in README.md

* update
2020-10-28 21:52:58 -07:00
haibingzhao 112de249a2
doc(frontend): volume support for tensorboard viewer and other visualize results (#4345)
* support local file storage type for local volume mount path, refer: https://github.com/kubeflow/pipelines/issues/4208

* add todo comment to support directory and filePath include wildcards '*', detail refer: https://github.com/kubeflow/pipelines/issues/4208

* revert old code indent

* run 'npm run format' to format code

* support tensorboard viewer and other visualize Results using volume mount path, modify 'file' schema to 'volume':

1. source schema: volume://volume-name/relative/path/from/volume/xxx.csv
2. for tensorboard(also support Series1:volume://volume-name/path_to_model_dir_1,Series2:volume://volume-name/path_to_model_dir_2):
* check volume-name was specified in podTemplateSpec( which was inject by VIEWER_TENSORBOARD_POD_TEMPLATE_SPEC_PATH env)
* check /relative/path/from/volume/xxx file path was prefix-mounted in podTemplateSpec
3. for others:
* check volume-name was specified at ml-pipeline-ui pod
* check /relative/path/from/volume/xxx.csv file path exist

* fix test and add more tests

* change error message not found to not exist.

* fix tensorboard create test

* combining volume mount path and key as artifacts path

* extra complex code to a function and add more test

* use ml-pipeline-ui container name to find server container instead of use containers[0]

* fix review suggestion: https://github.com/kubeflow/pipelines/pull/4236

* format code

* extract how to find file path on a pod volume to a common function, and optimize error message

* fix k8s-helper.test error

* add more documentation and fix mistake: volumeMountPath to filePathInVolume

* fix test error

* Update k8s-helper.test.ts

* format error message

* document volume support for tensorboard viewer and other visualize results

* add beta status

* change beta status to alpha status

Co-authored-by: Yuan (Bob) Gong <gongyuan94@gmail.com>
2020-08-16 17:56:17 -07:00
Alex Latchford 704c8c7660
chore: Clean up KFP SDK docstrings, make formatting a little more consistent (#4218)
* Prepare SDK docs environment so its easier to understand how to build the docs locally so theyre consistent with ReadTheDocs.

* Clean up docstrings for kfp.Client

* Add in updates to the docs for compiler and components

* Update components area to add in code references and make formatting a little more consistent.

* Clean up containers, add in custom CSS to ensure we do not overflow on inline code blocks

* Clean up containers, add in custom CSS to ensure we do not overflow on inline code blocks

* Remove unused kfp.notebook package links

* Clean up a few more errant references

* Clean up the DSL docs some more

* Update SDK docs for KFP extensions to follow Sphinx guidelines

* Clean up formatting of docstrings after Ark-Kuns comments
2020-08-04 00:33:47 +08:00
jingzhang36 48f3075f0a
A brief release announcement/note for KFP 1.0 (#4059)
* enable pagination when expanding experiment in both the home page and the archive page

* Revert "enable pagination when expanding experiment in both the home page and the archive page"

This reverts commit 5b672739dd.

* checkpoint

* Revert "checkpoint"

This reverts commit 3b17699301.

* Add a brief kfp 1.0 note, with pointers to our detailed docs

* have separate versioning policy file; have more links

* partially addressed comments

* address comments

* address comments

* fix a link

* fix alpha, beta

* address comments
2020-07-09 00:12:03 -07:00
Alexey Volkov d472d53a85
Docs - Show inherited members in the kfp.dsl docs (#4025)
Previously many ContainerOp members inherited from baseOp were not shown.
2020-06-18 19:25:58 -07:00
Alexey Volkov 180f0c51c8
Docs - Moved the kfp_server_api documentation to a separate page (#3899) 2020-06-04 11:15:56 +08:00
Alexey Volkov c67bc7baa9
Docs - Added docs for kfp_server_api.models (#3898) 2020-06-03 01:00:17 -07:00
Alexey Volkov 43ce6394bf
Docs - Added kfp.dsl placeholders to docs (#3813) 2020-05-22 13:23:14 -07:00
Alexey Volkov 4a961ce268
Client - Added documentation for the generated members (#3787) 2020-05-20 13:20:20 -07:00
Alexey Volkov 5163a6fdeb Docs - Added the kfp root members (#2183) 2019-10-07 18:33:19 -07:00
Alexey Volkov 9c9fb9d87e Docs - Added kfp.containers module (#2182)
And fixed the docstring
2019-09-24 13:43:59 -07:00
Riley Bauer 560dd2e9ce Set theme jekyll-theme-minimal 2019-05-31 14:14:31 -07:00
Alexey Volkov 329e8a50f0 Added the auto-generated python SDK docs (#1256)
* Added Python API reference docs

* Switched to the RTD theme

* Imporved the documentation

* Improved the docs

* Simplified the generator files

* Added sdk/python/requirements.txt

* Added licenses

* Added more information and comments to the conf.py file

* Added kfp.aws

* Fixed typos

* Removed the header

* Hiding some private classes

* Removed the explicit inclusion of kfp.components.structures as per Ning's request

* Added OWNERS file

* Changed the index title

* Removed the subheader

* Added the links to main documentation and source code

* Removed the listing of the kfp.components._structures
2019-05-17 18:55:06 -07:00
Sarah Maddox 1c8ecb30c6 Removed unused docs directory including OWNERS file and images. (#401) 2018-11-28 01:57:16 -08:00
hongye-sun ecf8af7bb1 add metric image file for wiki (#316)
* add metric image file for wiki

* fix the image file to correct content

* add more runs with metrics to the image
2018-11-19 17:53:58 -08:00
qimingj 69ee8b8b12 Update Screenshots. (#142) 2018-11-07 17:16:16 -08:00
Pascal Vicaire 3df28a9700 Updating OWNERS files. Adding per-subdirectory OWNER files. 2018-11-05 14:03:33 -08:00
Pascal Vicaire 633e2ddcc8 Initial commit of the kubeflow/pipeline project. 2018-11-02 14:02:31 -07:00