Skip to content

readme #9

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

Merged
merged 1 commit into from
Dec 22, 2020
Merged

readme #9

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
71 changes: 36 additions & 35 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,77 +209,78 @@ Currently we support the following api routes:
|===
|Feature|Code|Api route

|[small]#Retrieve all models#
|[small]#Get all models#
|[small]#modzyClient.getAllModels()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
|[small]#link:{doc-pages}marketplace/models/retrieve-all-models-versions[/api/models/all/versions/all]#

|[small]#Retrieve some models#
|[small]#List some models#
|[small]#modzyClient.getModels()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
|[small]#link:{doc-pages}marketplace/models/retrieve-models[/api/models]#

|[small]#Retrieve model details#
|[small]#Get model details#
|[small]#modzyClient.getModel()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-model-details[api/models/:model-id]#
|[small]#link:{doc-pages}marketplace/models/retrieve-model-details[/api/models/:modelId]#

|[small]#Retrieve model by name#
|[small]#Search models by name#
|[small]#modzyClient.getModelByName()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models[api/models]#
|[small]#link:{doc-pages}marketplace/models/search-model-details[/api/models/search]#

|[small]#Retrieve related models#
|[small]#Get related models#
|[small]#modzyClient.getRelatedModels()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-related-models[api/models/:model-id/related-models]#
|[small]#link:{doc-pages}marketplace/models/retrieve-related-models[/api/models/:modelId/related-models]#

|[small]#Retrieve model versions#
|[small]#List model versions#
|[small]#modzyClient.getModelVersions()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-related-models[api/models/:model-id/versions]#
|[small]#link:{doc-pages}marketplace/versions/retrieve-versions[/api/models/:modelId/versions]#

|[small]#Retrieve model version details#
|[small]#Get version details#
|[small]#modzyClient.getModelVersion()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-related-models[api/models/:model-id/versions/:version-id]#
|[small]#link:{doc-pages}marketplace/versions/retrieve-version-details[/api/models/:modelId/versions/:version]#

|[small]#Retrieve all tags#
|[small]#List tags#
|[small]#modzyClient.getAllTags()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-tags[api/models/tags]#
|[small]#link:{doc-pages}marketplace/tags/retrieve-tags[/api/models/tags]#

|[small]#Retrieve Tags and Models#
|[small]#Get models by tags#
|[small]#modzyClient.getTagsAndModels()#
|[small]#link:{doc-pages}api-reference/marketplace/retrieve-models-by-tags[api/models/tags/:tag-id]#
|[small]#link:{doc-pages}marketplace/tags/retrieve-models-by-tags[/api/models/tags/:tagId]#

|[small]#Submit a Job (Text)#
|[small]#Create a Job (Text)#
|[small]#modzyClient.submitJobText()#
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#

|[small]#Submit a Job (Embedded)#
|[small]#Create a Job (Embedded)#
|[small]#modzyClient.submitJobEmbedded()#
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
|[small]#link:{doc-pages}jobs/jobs/submit-job-embedded[/api/jobs]#

|[small]#Submit a Job (AWS S3)#
|[small]#Create a Job (AWS S3)#
|[small]#modzyClient.submitJobAWSS3()#
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
|[small]#link:{doc-pages}jobs/jobs/submit-job-aws[/api/jobs]#

|[small]#Submit a Job (JDBC)#
|[small]#Create a Job (JDBC)#
|[small]#modzyClient.submitJobJDBC()#
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
|[small]#link:{doc-pages}jobs/jobs/submit-job-jdbc[/api/jobs]#

|[small]#Cancel job#
|[small]#Cancel a job#
|[small]#modzyClient.cancelJob()#
|[small]#link:{doc-pages}api-reference/jobs/cancel-pending-job[api/jobs/:job-id]#
|[small]#link:{doc-pages}jobs/jobs/cancel-pending-job[/api/jobs/:jobId]#

|[small]#Hold until inference is complete#
|[small]#modzyClient.blockUntilComplete()#
|[small]#link:{doc-pages}api-reference/job-inputs/submit-job[api/jobs]#
|[small]#link:{doc-pages}jobs/jobs/submit-job-text[/api/jobs]#

|[small]#Get Job details#
|[small]#Get job details#
|[small]#modzyClient.getJob()#
|[small]#link:{doc-pages}api-reference/jobs/retrieve-job-details[api/jobs/:job-id]#
|[small]#link:{doc-pages}jobs/jobs/retrieve-job-details[/api/jobs/:jobId]#

|[small]#Retrieve results#
|[small]#Get results#
|[small]#modzyClient.cancelJob()#
|[small]#link:{doc-pages}api-reference/jobs/cancel-pending-job[api/jobs/:job-id]#
|[small]#link:{doc-pages}jobs/results/retrieve-results[/api/results/:jobId]#

|[small]#Retrieve Job History#
|[small]#List the job history#
|[small]#modzyClient.getJobHistory()#
|[small]#link:{doc-pages}api-reference/jobs/retrieve-job-history[api/jobs/history]#
|[small]#link:{doc-pages}jobs/job-history/retrieve-job-history[/api/jobs/history]#


|===

Expand Down