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.

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

docs(ai): add ai-subnet documentation #549

Merged
merged 77 commits into from May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
5ea3a59
docs(ai): add on-chain discovery documentation
rickstaa Apr 18, 2024
d685ecd
docs(ai): improve subsection titles and discovery text
rickstaa Apr 18, 2024
2b2f204
docs(ai): improve introduction text
rickstaa Apr 18, 2024
7b1d280
ci(ai): add AI pipelines document structure
rickstaa Apr 18, 2024
ee4d37f
docs(ai): add artibtrum explorer discovery steps
rickstaa Apr 19, 2024
8eba5f0
docs(ai): add AI API reference
rickstaa Apr 19, 2024
428a92e
chore(ai): cleanup redundant OpenAPI entries
rickstaa Apr 19, 2024
9b03631
ci(ai): add AI docs codeowners
rickstaa Apr 21, 2024
6b88093
docs(ai): add pipelines documentation
rickstaa Apr 25, 2024
0cdda07
docs(ai): fix broken images
rickstaa Apr 25, 2024
c04efec
feat(ai): temporarily use external paths for pipeline images
rickstaa Apr 25, 2024
56cfebb
feat(ai): add contribution pages scaffold
rickstaa Apr 26, 2024
4e341d6
feat(ai): add contribution pages scaffold (#553)
rickstaa Apr 26, 2024
de30783
Livepeer.Cloud SPE Milestone #1 Deliverables: Add Gateway Docs
mikezupper Apr 26, 2024
4e03074
docs(ai): improve AI subnet introduction
rickstaa Apr 30, 2024
074dc52
Merge branch 'add_contribution_guides_scafold' into ai-video
rickstaa Apr 30, 2024
a00dabb
fix(ai): fix kickstart collab card link
rickstaa Apr 30, 2024
b60a811
refactor(ai): improve pipeline mermaid diagrams
rickstaa Apr 30, 2024
283cd00
refactor(ai): improve pipeline documentation
rickstaa Apr 30, 2024
8fb2b86
fix(ai): implement temporary solution for mermaid image issue
rickstaa Apr 30, 2024
632db94
feat(ai): add builders page
rickstaa May 1, 2024
b8f15a9
refactor(ai): add cloud API disclaimer
rickstaa May 1, 2024
95fa5c0
feat(ai): add orchestrator setup guide
rickstaa May 1, 2024
c0e121b
Merge branch 'main' into ai-video
rickstaa May 1, 2024
8563d95
refactor(ai): improve showcase descriptions
rickstaa May 1, 2024
79fe635
refactor(ai): highlight showcase keywords
rickstaa May 1, 2024
a9d9ad3
feat(ai): add AI gateway docs
rickstaa May 1, 2024
0ba3b91
refactor(ai): adopt impersonal writing style (#556)
rickstaa May 1, 2024
25530e0
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 1, 2024
59b4db9
fix(ai): fix broken AI gateway links
rickstaa May 1, 2024
7c66d4a
refactor(ai): improve AI subnet introduction section
rickstaa May 1, 2024
9197ab7
refactor(ai): hide contribution/SDK pages and cleanup pipelines
rickstaa May 1, 2024
46f4865
refactor(ai): improve text formatting
rickstaa May 1, 2024
c27c7d9
addressed review comments from Rick
mikezupper May 1, 2024
05871be
refactor(ai): add model parameter callout to API docs
rickstaa May 1, 2024
0f58773
chore(ai): fix small typo
rickstaa May 1, 2024
e504e64
refactor(ai): fix spelling
rickstaa May 1, 2024
ec47a72
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 1, 2024
d1fd937
made Prerequisites - more concise
mikezupper May 2, 2024
4e7999f
chore(ai): add Analytics token
rickstaa May 2, 2024
d78d712
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 2, 2024
38b420c
docs(gateway): apply prettier mdx formatting
rickstaa May 2, 2024
108a7e5
refactor(ai): gateway former naming comment
rickstaa May 3, 2024
dd8e816
refactor(ai): simplify binary install
rickstaa May 4, 2024
ef79565
docs(ai): apply community feedback
rickstaa May 4, 2024
b6606e1
docs(ai): add RealViz warm comment
rickstaa May 5, 2024
8bc7f00
docs(ai): fix incorrect RealViLightning model link
rickstaa May 13, 2024
c652980
chore(ai): update AI subnet OpenAPI spec
rickstaa May 13, 2024
416abd3
docs: replace -broadcaster flag with -gateway in AI subnet documentat…
eliteprox May 13, 2024
3916033
docs(ai): remove pricePerUnit requirement for AI docs (#565)
eliteprox May 14, 2024
c67331e
docs(ai): add RealVisXL to I2I pipeline
rickstaa May 15, 2024
8c68293
Merge pull request #3 from livepeer/task/papa/add_gateway_prettier
mikezupper May 16, 2024
1a10885
docs: add Gateway network page
rickstaa May 16, 2024
9e8f717
docs: improve Gateway configuration wording
rickstaa May 16, 2024
b9b57e9
Merge pull request #4 from livepeer/tasks/papa/add_gateway_add_gatewa…
mikezupper May 16, 2024
879530e
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 16, 2024
8a380e1
chore: apply prettier to Gateway node page
rickstaa May 16, 2024
7887cff
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 16, 2024
d535cad
Update gateways.mdx
dob May 16, 2024
f55e514
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 16, 2024
3878ada
docs: fix Gateway node page links
rickstaa May 16, 2024
467744c
Merge branch 'tasks/papa/add_gateway' into ai-video
rickstaa May 16, 2024
b203eb8
:erge branch 'main' into ai-video
rickstaa May 16, 2024
f3851af
docs(ai): remove double subnet requirements text
rickstaa May 17, 2024
2359bed
docs(ai): address community feedback
rickstaa May 17, 2024
c12a79e
docs(ai): enhance introduction
rickstaa May 17, 2024
7755f69
docs(ai): add DeepCache optimization method
rickstaa May 17, 2024
833caae
docs(ai): replace dApp with application
rickstaa May 19, 2024
1c37adb
Merge branch 'main' into ai-video
rickstaa May 19, 2024
b7bacee
docs(ai): ensure GPU binaries are listed
rickstaa May 20, 2024
c8069e2
docs(ai): fix incorrect binary format
rickstaa May 20, 2024
9e0761d
docs(ai): add HuggingFace token read permission comment
rickstaa May 20, 2024
9785dcc
docs(ai): improve introduction
rickstaa May 20, 2024
0bc2c0e
docs(ai): change dApp to app
rickstaa May 20, 2024
ce3c882
docs(ai): apply some small text improvements
rickstaa May 20, 2024
5a96ebe
docs(ai): update AI API reference
rickstaa May 20, 2024
32774e2
refactor(ai) improve introduction wording (#570)
rickstaa May 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -0,0 +1,2 @@
# Default reviewers for the AI documentation.
ai/ @rickstaa
3 changes: 2 additions & 1 deletion .gitignore
@@ -1,5 +1,6 @@
node_modules
.DS_Store

# IDEs
# IDE
.vscode
*.code-workspace
345 changes: 345 additions & 0 deletions ai/api-reference/ai-openapi-schema.yml
@@ -0,0 +1,345 @@
openapi: 3.1.0
info:
title: Livepeer AI Runner
description: An application to run AI pipelines
version: 0.1.0
servers:
- url: https://dream-gateway.livepeer.cloud
description: Livepeer Cloud Community Gateway
paths:
/text-to-image:
post:
summary: Text To Image
operationId: text_to_image
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TextToImageParams'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ImageResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/image-to-image:
post:
summary: Image To Image
operationId: image_to_image
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_image_to_image_image_to_image_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ImageResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/image-to-video:
post:
summary: Image To Video
operationId: image_to_video
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_image_to_video_image_to_video_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VideoResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
APIError:
properties:
msg:
type: string
title: Msg
type: object
required:
- msg
title: APIError
Body_image_to_image_image_to_image_post:
properties:
prompt:
type: string
title: Prompt
image:
type: string
format: binary
title: Image
model_id:
type: string
title: Model Id
default: ''
strength:
type: number
title: Strength
default: 0.8
guidance_scale:
type: number
title: Guidance Scale
default: 7.5
negative_prompt:
type: string
title: Negative Prompt
default: ''
safety_check:
type: boolean
title: Safety Check
default: true
seed:
type: integer
title: Seed
num_images_per_prompt:
type: integer
title: Num Images Per Prompt
default: 1
type: object
required:
- prompt
- image
- model_id
title: Body_image_to_image_image_to_image_post
Body_image_to_video_image_to_video_post:
properties:
image:
type: string
format: binary
title: Image
model_id:
type: string
title: Model Id
default: ''
height:
type: integer
title: Height
default: 576
width:
type: integer
title: Width
default: 1024
fps:
type: integer
title: Fps
default: 6
motion_bucket_id:
type: integer
title: Motion Bucket Id
default: 127
noise_aug_strength:
type: number
title: Noise Aug Strength
default: 0.02
seed:
type: integer
title: Seed
type: object
required:
- image
- model_id
title: Body_image_to_video_image_to_video_post
HTTPError:
properties:
detail:
$ref: '#/components/schemas/APIError'
type: object
required:
- detail
title: HTTPError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
HealthCheck:
properties:
status:
type: string
title: Status
default: OK
type: object
title: HealthCheck
ImageResponse:
properties:
images:
items:
$ref: '#/components/schemas/Media'
type: array
title: Images
type: object
required:
- images
title: ImageResponse
Media:
properties:
url:
type: string
title: Url
seed:
type: integer
title: Seed
nsfw:
type: boolean
title: Nsfw
type: object
required:
- url
- seed
- nsfw
title: Media
TextToImageParams:
properties:
model_id:
type: string
title: Model Id
default: ''
prompt:
type: string
title: Prompt
height:
type: integer
title: Height
width:
type: integer
title: Width
guidance_scale:
type: number
title: Guidance Scale
default: 7.5
negative_prompt:
type: string
title: Negative Prompt
default: ''
safety_check:
type: boolean
title: Safety Check
default: true
seed:
type: integer
title: Seed
num_inference_steps:
type: integer
title: Num Inference Steps
default: 50
num_images_per_prompt:
type: integer
title: Num Images Per Prompt
default: 1
type: object
required:
- prompt
- model_id
title: TextToImageParams
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
VideoResponse:
properties:
frames:
items:
items:
$ref: '#/components/schemas/Media'
type: array
type: array
title: Frames
type: object
required:
- frames
title: VideoResponse
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
3 changes: 3 additions & 0 deletions ai/api-reference/health.mdx
@@ -0,0 +1,3 @@
---
openapi: get /health
---
21 changes: 21 additions & 0 deletions ai/api-reference/image-to-image.mdx
@@ -0,0 +1,21 @@
---
openapi: post /image-to-image
---

<Info>
The public [Livepeer.cloud](https://www.livepeer.cloud/) Gateway used in this
guide is intended for experimentation and is not guaranteed for production
use. It is a free, non-token-gated, but rate-limited service designed for
testing purposes. For production-ready applications, consider setting up your
own Gateway node or partnering with one via the `ai-video` channel on
[Discord](https://discord.gg/livepeer).
</Info>

<Note>
Please note that the **optimal** parameters for a given model may vary
depending on the specific model and use case. The parameters provided in this
guide are not model-specific and should be used as a starting point.
Additionally, some models may have parameters such as `guiding_scale` and
`num_inference_steps` disabled by default. For more information on
model-specific parameters, please refer to the respective model documentation.
</Note>