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

Fix tester docs to point to correct links #307

Merged
merged 1 commit into from
Nov 22, 2018
Merged

Fix tester docs to point to correct links #307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/api-testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Whether you have wrapped your component using [our S2I wrappers](./wrappers/readme.md) or created your own wrapper you will want to test the Docker container standalone and also quickly within a running cluster. We have provided two python tools to allow you to easily do this

* [Microservice API Tester](../util/api_tester)
* Allows you to test a docker component to check it respects the Seldon API
* [Seldon-Core API Tester](../wrappers/testing)
* [Microservice API Tester](../wrappers/testing)
* Allows you to test a docker component to check it respects the Seldon internal microservice API
* [Seldon-Core API Tester](../util/api_tester)
* Allows you to test the external endpoints for a running Seldon Deployment graph.


## Microservice API Tester
## Seldon-Core API Tester

Use this [script](../util/api_tester/api-tester.py) to test a Seldon graph deployed to a cluster.

Expand Down Expand Up @@ -50,7 +50,7 @@ python api-tester.py contract.json 0.0.0.0 8003 --oauth-key oauth-key --oauth-s

You can find more exampes in the [example models folder notebooks](../examples/models).

## Seldon API Tester
## Microservice API Tester

Use this [script](../wrappers/testing/tester.py) to test a packaged Docker microservice Seldon component.

Expand Down Expand Up @@ -83,7 +83,7 @@ python tester.py contract.json 0.0.0.0 5000 -p --grpc

The above sends a predict call to a gRPC component exposed at 0.0.0.0:5000 using the contract.json to create a random request.

You can find more exampes in the [example models folder notebooks](../examples/models).
You can find more examples in the [example models folder notebooks](../examples/models).

## API Contract

Expand Down Expand Up @@ -149,4 +149,3 @@ Each section has a list of definitions. Each definition consists of:
* ```range``` : list of two numbers : Optional for ftype CONTINUOUS : The range of values (inclusive) that a continuous value can take
* ```repeat``` : integer : Optional value for how many times to repeat this value
* ```shape``` : array of integers : Optional value for the shape of array to coerce the values