Skip to content

Commit

Permalink
Fix dead links on PyPI
Browse files Browse the repository at this point in the history
The KServe Python SDK README.md uses relative URLs that work well on GitHub but return a 404 error when visited on PyPI.

This change updates the README.md to use absolute URLs that work well on both GitHub and PyPI.
  • Loading branch information
kevinbazira committed Jun 20, 2024
1 parent 7f0f5e0 commit 38044fa
Showing 1 changed file with 49 additions and 49 deletions.
98 changes: 49 additions & 49 deletions python/kserve/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,59 +82,59 @@ Additionally, the latencies of each step are logged per request.

### Getting Started

KServe's python client interacts with KServe control plane APIs for executing operations on a remote KServe cluster, such as creating, patching and deleting of a InferenceService instance. See the [Sample for Python SDK Client](../../docs/samples/client) to get started.
KServe's python client interacts with KServe control plane APIs for executing operations on a remote KServe cluster, such as creating, patching and deleting of a InferenceService instance. See the [Sample for Python SDK Client](https://github.com/kserve/kserve/tree/master/docs/samples/client) to get started.

### Documentation for Client API

Please review [KServe Client API](https://github.com/kserve/website/blob/main/docs/sdk_docs/docs/KServeClient.md) docs.

## Documentation For Models

- [KnativeAddressable](docs/KnativeAddressable.md)
- [KnativeCondition](docs/KnativeCondition.md)
- [KnativeURL](docs/KnativeURL.md)
- [KnativeVolatileTime](docs/KnativeVolatileTime.md)
- [NetUrlUserinfo](docs/NetUrlUserinfo.md)
- [V1alpha1InferenceGraph](docs/V1alpha1InferenceGraph.md)
- [V1alpha1InferenceGraphList](docs/V1alpha1InferenceGraphList.md)
- [V1alpha1InferenceGraphSpec](docs/V1alpha1InferenceGraphSpec.md)
- [V1alpha1InferenceGraphStatus](docs/V1alpha1InferenceGraphStatus.md)
- [V1alpha1InferenceRouter](docs/V1alpha1InferenceRouter.md)
- [V1alpha1InferenceStep](docs/V1alpha1InferenceStep.md)
- [V1alpha1InferenceTarget](docs/V1alpha1InferenceTarget.md)
- [V1beta1AlibiExplainerSpec](docs/V1beta1AlibiExplainerSpec.md)
- [V1beta1Batcher](docs/V1beta1Batcher.md)
- [V1beta1ComponentExtensionSpec](docs/V1beta1ComponentExtensionSpec.md)
- [V1beta1ComponentStatusSpec](docs/V1beta1ComponentStatusSpec.md)
- [V1beta1CustomExplainer](docs/V1beta1CustomExplainer.md)
- [V1beta1CustomPredictor](docs/V1beta1CustomPredictor.md)
- [V1beta1CustomTransformer](docs/V1beta1CustomTransformer.md)
- [V1beta1ExplainerConfig](docs/V1beta1ExplainerConfig.md)
- [V1beta1ExplainerSpec](docs/V1beta1ExplainerSpec.md)
- [V1beta1ExplainersConfig](docs/V1beta1ExplainersConfig.md)
- [V1beta1InferenceService](docs/V1beta1InferenceService.md)
- [V1beta1InferenceServiceList](docs/V1beta1InferenceServiceList.md)
- [V1beta1InferenceServiceSpec](docs/V1beta1InferenceServiceSpec.md)
- [V1beta1InferenceServiceStatus](docs/V1beta1InferenceServiceStatus.md)
- [V1beta1InferenceServicesConfig](docs/V1beta1InferenceServicesConfig.md)
- [V1beta1IngressConfig](docs/V1beta1IngressConfig.md)
- [V1beta1LoggerSpec](docs/V1beta1LoggerSpec.md)
- [V1beta1ModelSpec](docs/V1beta1ModelSpec.md)
- [V1beta1ONNXRuntimeSpec](docs/V1beta1ONNXRuntimeSpec.md)
- [V1beta1PodSpec](docs/V1beta1PodSpec.md)
- [V1beta1PredictorConfig](docs/V1beta1PredictorConfig.md)
- [V1beta1PredictorExtensionSpec](docs/V1beta1PredictorExtensionSpec.md)
- [V1beta1PredictorSpec](docs/V1beta1PredictorSpec.md)
- [V1beta1PredictorsConfig](docs/V1beta1PredictorsConfig.md)
- [V1beta1SKLearnSpec](docs/V1beta1SKLearnSpec.md)
- [V1beta1TFServingSpec](docs/V1beta1TFServingSpec.md)
- [V1beta1TorchServeSpec](docs/V1beta1TorchServeSpec.md)
- [V1beta1TrainedModel](docs/V1beta1TrainedModel.md)
- [V1beta1TrainedModelList](docs/V1beta1TrainedModelList.md)
- [V1beta1TrainedModelSpec](docs/V1beta1TrainedModelSpec.md)
- [V1beta1TrainedModelStatus](docs/V1beta1TrainedModelStatus.md)
- [V1beta1TransformerConfig](docs/V1beta1TransformerConfig.md)
- [V1beta1TransformerSpec](docs/V1beta1TransformerSpec.md)
- [V1beta1TransformersConfig](docs/V1beta1TransformersConfig.md)
- [V1beta1TritonSpec](docs/V1beta1TritonSpec.md)
- [V1beta1XGBoostSpec](docs/V1beta1XGBoostSpec.md)
- [KnativeAddressable](https://github.com/kserve/kserve/blob/master/python/kserve/docs/KnativeAddressable.md)
- [KnativeCondition](https://github.com/kserve/kserve/blob/master/python/kserve/docs/KnativeCondition.md)
- [KnativeURL](https://github.com/kserve/kserve/blob/master/python/kserve/docs/KnativeURL.md)
- [KnativeVolatileTime](https://github.com/kserve/kserve/blob/master/python/kserve/docs/KnativeVolatileTime.md)
- [NetUrlUserinfo](https://github.com/kserve/kserve/blob/master/python/kserve/docs/NetUrlUserinfo.md)
- [V1alpha1InferenceGraph](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceGraph.md)
- [V1alpha1InferenceGraphList](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceGraphList.md)
- [V1alpha1InferenceGraphSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceGraphSpec.md)
- [V1alpha1InferenceGraphStatus](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceGraphStatus.md)
- [V1alpha1InferenceRouter](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceRouter.md)
- [V1alpha1InferenceStep](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceStep.md)
- [V1alpha1InferenceTarget](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1alpha1InferenceTarget.md)
- [V1beta1AlibiExplainerSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1AlibiExplainerSpec.md)
- [V1beta1Batcher](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1Batcher.md)
- [V1beta1ComponentExtensionSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ComponentExtensionSpec.md)
- [V1beta1ComponentStatusSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ComponentStatusSpec.md)
- [V1beta1CustomExplainer](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1CustomExplainer.md)
- [V1beta1CustomPredictor](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1CustomPredictor.md)
- [V1beta1CustomTransformer](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1CustomTransformer.md)
- [V1beta1ExplainerConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ExplainerConfig.md)
- [V1beta1ExplainerSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ExplainerSpec.md)
- [V1beta1ExplainersConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ExplainersConfig.md)
- [V1beta1InferenceService](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1InferenceService.md)
- [V1beta1InferenceServiceList](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1InferenceServiceList.md)
- [V1beta1InferenceServiceSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1InferenceServiceSpec.md)
- [V1beta1InferenceServiceStatus](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1InferenceServiceStatus.md)
- [V1beta1InferenceServicesConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1InferenceServicesConfig.md)
- [V1beta1IngressConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1IngressConfig.md)
- [V1beta1LoggerSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1LoggerSpec.md)
- [V1beta1ModelSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ModelSpec.md)
- [V1beta1ONNXRuntimeSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1ONNXRuntimeSpec.md)
- [V1beta1PodSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1PodSpec.md)
- [V1beta1PredictorConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1PredictorConfig.md)
- [V1beta1PredictorExtensionSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1PredictorExtensionSpec.md)
- [V1beta1PredictorSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1PredictorSpec.md)
- [V1beta1PredictorsConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1PredictorsConfig.md)
- [V1beta1SKLearnSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1SKLearnSpec.md)
- [V1beta1TFServingSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TFServingSpec.md)
- [V1beta1TorchServeSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TorchServeSpec.md)
- [V1beta1TrainedModel](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TrainedModel.md)
- [V1beta1TrainedModelList](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TrainedModelList.md)
- [V1beta1TrainedModelSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TrainedModelSpec.md)
- [V1beta1TrainedModelStatus](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TrainedModelStatus.md)
- [V1beta1TransformerConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TransformerConfig.md)
- [V1beta1TransformerSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TransformerSpec.md)
- [V1beta1TransformersConfig](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TransformersConfig.md)
- [V1beta1TritonSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1TritonSpec.md)
- [V1beta1XGBoostSpec](https://github.com/kserve/kserve/blob/master/python/kserve/docs/V1beta1XGBoostSpec.md)

0 comments on commit 38044fa

Please sign in to comment.