openapi in readthedocs

This commit is contained in:
Xi Yan 2024-11-22 17:24:03 -08:00
parent dbd4b9ecce
commit 3a40a2b483
3 changed files with 41 additions and 41 deletions

View file

@ -443,7 +443,7 @@ class Generator:
"PostTraining",
"BatchInference",
]:
op.defining_class.__name__ = f"(Coming Soon) {op.defining_class.__name__}"
op.defining_class.__name__ = f"{op.defining_class.__name__} (Coming Soon)"
print(op.defining_class.__name__)
doc_string = parse_type(op.func_ref)

View file

@ -21,7 +21,7 @@
"info": {
"title": "Llama Stack Specification",
"version": "alpha",
"description": "This is the specification of the Llama Stack that provides\n a set of endpoints and their corresponding interfaces that are tailored to\n best leverage Llama Models. Generated at 2024-11-22 17:22:31.150049"
"description": "This is the specification of the Llama Stack that provides\n a set of endpoints and their corresponding interfaces that are tailored to\n best leverage Llama Models. Generated at 2024-11-22 17:23:55.034164"
},
"servers": [
{
@ -44,7 +44,7 @@
}
},
"tags": [
"(Coming Soon) BatchInference"
"BatchInference (Coming Soon)"
],
"parameters": [
{
@ -84,7 +84,7 @@
}
},
"tags": [
"(Coming Soon) BatchInference"
"BatchInference (Coming Soon)"
],
"parameters": [
{
@ -117,7 +117,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -1079,7 +1079,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -1117,7 +1117,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -1155,7 +1155,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -1193,7 +1193,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -1713,7 +1713,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -2161,7 +2161,7 @@
}
},
"tags": [
"(Coming Soon) PostTraining"
"PostTraining (Coming Soon)"
],
"parameters": [
{
@ -2201,7 +2201,7 @@
}
},
"tags": [
"(Coming Soon) SyntheticDataGeneration"
"SyntheticDataGeneration (Coming Soon)"
],
"parameters": [
{
@ -7927,15 +7927,6 @@
}
],
"tags": [
{
"name": "(Coming Soon) BatchInference"
},
{
"name": "(Coming Soon) PostTraining"
},
{
"name": "(Coming Soon) SyntheticDataGeneration"
},
{
"name": "AgentCandidate",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgentCandidate\" />"
@ -8011,6 +8002,9 @@
"name": "BatchCompletionResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionResponse\" />"
},
{
"name": "BatchInference (Coming Soon)"
},
{
"name": "BenchmarkEvalTaskConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BenchmarkEvalTaskConfig\" />"
@ -8262,6 +8256,9 @@
"name": "PhotogenToolDefinition",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PhotogenToolDefinition\" />"
},
{
"name": "PostTraining (Coming Soon)"
},
{
"name": "PostTrainingJob",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJob\" />"
@ -8450,6 +8447,9 @@
"name": "SyntheticDataGenerateRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerateRequest\" />"
},
{
"name": "SyntheticDataGeneration (Coming Soon)"
},
{
"name": "SyntheticDataGenerationResponse",
"description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationResponse\" />"
@ -8558,10 +8558,8 @@
{
"name": "Operations",
"tags": [
"(Coming Soon) BatchInference",
"(Coming Soon) PostTraining",
"(Coming Soon) SyntheticDataGeneration",
"Agents",
"BatchInference (Coming Soon)",
"DatasetIO",
"Datasets",
"Eval",
@ -8571,10 +8569,12 @@
"Memory",
"MemoryBanks",
"Models",
"PostTraining (Coming Soon)",
"Safety",
"Scoring",
"ScoringFunctions",
"Shields",
"SyntheticDataGeneration (Coming Soon)",
"Telemetry"
]
},

View file

@ -3400,7 +3400,7 @@ components:
info:
description: "This is the specification of the Llama Stack that provides\n \
\ a set of endpoints and their corresponding interfaces that are tailored\
\ to\n best leverage Llama Models. Generated at 2024-11-22 17:22:31.150049"
\ to\n best leverage Llama Models. Generated at 2024-11-22 17:23:55.034164"
title: Llama Stack Specification
version: alpha
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
@ -3658,7 +3658,7 @@ paths:
$ref: '#/components/schemas/BatchChatCompletionResponse'
description: OK
tags:
- (Coming Soon) BatchInference
- BatchInference (Coming Soon)
/alpha/batch-inference/completion:
post:
parameters:
@ -3683,7 +3683,7 @@ paths:
$ref: '#/components/schemas/BatchCompletionResponse'
description: OK
tags:
- (Coming Soon) BatchInference
- BatchInference (Coming Soon)
/alpha/datasetio/get-rows-paginated:
get:
parameters:
@ -4337,7 +4337,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJobArtifactsResponse'
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/post-training/job/cancel:
post:
parameters:
@ -4358,7 +4358,7 @@ paths:
'200':
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/post-training/job/logs:
get:
parameters:
@ -4382,7 +4382,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJobLogStream'
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/post-training/job/status:
get:
parameters:
@ -4406,7 +4406,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJobStatusResponse'
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/post-training/jobs:
get:
parameters:
@ -4425,7 +4425,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJob'
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/post-training/preference-optimize:
post:
parameters:
@ -4450,7 +4450,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJob'
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/post-training/supervised-fine-tune:
post:
parameters:
@ -4475,7 +4475,7 @@ paths:
$ref: '#/components/schemas/PostTrainingJob'
description: OK
tags:
- (Coming Soon) PostTraining
- PostTraining (Coming Soon)
/alpha/providers/list:
get:
parameters:
@ -4755,7 +4755,7 @@ paths:
$ref: '#/components/schemas/SyntheticDataGenerationResponse'
description: OK
tags:
- (Coming Soon) SyntheticDataGeneration
- SyntheticDataGeneration (Coming Soon)
/alpha/telemetry/get-trace:
get:
parameters:
@ -4806,9 +4806,6 @@ security:
servers:
- url: http://any-hosted-llama-stack.com
tags:
- name: (Coming Soon) BatchInference
- name: (Coming Soon) PostTraining
- name: (Coming Soon) SyntheticDataGeneration
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentCandidate" />
name: AgentCandidate
- description: <SchemaDefinition schemaRef="#/components/schemas/AgentConfig" />
@ -4866,6 +4863,7 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionResponse"
/>
name: BatchCompletionResponse
- name: BatchInference (Coming Soon)
- description: <SchemaDefinition schemaRef="#/components/schemas/BenchmarkEvalTaskConfig"
/>
name: BenchmarkEvalTaskConfig
@ -5046,6 +5044,7 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/PhotogenToolDefinition"
/>
name: PhotogenToolDefinition
- name: PostTraining (Coming Soon)
- description: <SchemaDefinition schemaRef="#/components/schemas/PostTrainingJob"
/>
name: PostTrainingJob
@ -5180,6 +5179,7 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerateRequest"
/>
name: SyntheticDataGenerateRequest
- name: SyntheticDataGeneration (Coming Soon)
- description: 'Response from the synthetic data generation. Batch of (prompt, response,
score) tuples that pass the threshold.
@ -5261,10 +5261,8 @@ tags:
x-tagGroups:
- name: Operations
tags:
- (Coming Soon) BatchInference
- (Coming Soon) PostTraining
- (Coming Soon) SyntheticDataGeneration
- Agents
- BatchInference (Coming Soon)
- DatasetIO
- Datasets
- Eval
@ -5274,10 +5272,12 @@ x-tagGroups:
- Memory
- MemoryBanks
- Models
- PostTraining (Coming Soon)
- Safety
- Scoring
- ScoringFunctions
- Shields
- SyntheticDataGeneration (Coming Soon)
- Telemetry
- name: Types
tags: