kubeflow / trainer / 27766640573
65%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 40
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 64.626% (-0.08%) from 64.709%
27766640573

push

github

web-flow 
feat(docs): add dedicated documentation website (#3308)

* feat(docs): add initial documentation structure and configuration for Kubeflow Trainer

- Introduced .readthedocs.yaml for ReadTheDocs configuration.
- Created Makefile for building and serving documentation.
- Added Sphinx configuration in docs/conf.py.
- Established index.rst as the main entry point for documentation.
- Developed user guides for various frameworks including PyTorch, JAX, and DeepSpeed.
- Implemented custom CSS for documentation styling.
- Included a distributed data cache guide and a DeepSpeed integration guide.

This commit sets up the foundational documentation for the Kubeflow Trainer, enhancing accessibility and usability for users.

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>

* feat(docs): update user guides and restructure documentation for Kubeflow Trainer

- Renamed and reorganized user guides to better serve different audiences: AI practitioners, cluster operators, and contributors.
- Added new sections for documentation on the Kubeflow Training Operator v1 and legacy guides.
- Enhanced descriptions to clarify the purpose and content of each guide, improving overall accessibility and usability.

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>

* feat(docs): add comprehensive operator guides for Kubeflow Trainer

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>

* feat(docs): enhance operator guides for Kubeflow Trainer

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>

* fixed user-guides

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>

* feat(docs): add initial API reference and contributor guides for Kubeflow Trainer

- Introduced API reference documentation for Python SDK and Kubernetes CRD types, including TrainJob, TrainingRuntime, and ClusterTrainingRuntime.
- Created contributor guides covering architecture, community, and contributing processes.
- Added legacy v1 documentation structure with sections for installation an... (continued)

2333 of 3610 relevant lines covered (64.63%)

0.75 hits per line

Coverage Regressions

Lines Coverage ∆ File
3
74.07
 -11.11% pkg/runtime/core/core.go
Jobs
ID Job ID Ran Files Coverage
1 27766640573.1 40
64.63
 GitHub Action Run
Source Files on build 27766640573