Skip to content

feat: socaity.run() one-liner + 0.1.13 readme and banner#2

Open
luisfilipemed wants to merge 3 commits into
mainfrom
feat/socaity-run-and-readme
Open

feat: socaity.run() one-liner + 0.1.13 readme and banner#2
luisfilipemed wants to merge 3 commits into
mainfrom
feat/socaity-run-and-readme

Conversation

@luisfilipemed

Copy link
Copy Markdown

What

  • socaity.run("vendor/model", **inputs): a one line way to run any catalog model. It resolves the service, installs it on demand, calls its primary endpoint and returns the result. api_key defaults to SOCAITY_API_KEY.
  • New README written to the current 0.1.13 reality. The old one described a simple api (text2img / text2speech) and import paths that no longer exist. The new one leads with socaity.run().
  • New hero banner derived from the socaity_frontend home hero, developer focused.

Why

The repo README and examples were stale against the refactored product. No engine changes were needed: 0.1.13 already matches the new backend, so this PR is the convenience entrypoint plus accurate docs and visuals.

Verified live (prod)

  • socaity.run("black-forest-labs/flux-schnell", prompt=...) returns a 1024x1024 ImageFile
  • socaity.run("deepseek-ai/deepseek-v3", prompt=...) returns the token chunks
  • install, deep import and call verified end to end as well

No code changes outside socaity/__init__.py. Brand voice and palette, no em-dashes.

socaity.run("vendor/model", **inputs) resolves the service, installs it on
demand, calls its primary endpoint and returns the result. api_key defaults
to SOCAITY_API_KEY. Verified live against flux-schnell and deepseek-v3.
Replace the outdated readme (which described a simple api and import paths
that no longer exist) with accurate, current usage led by socaity.run().
Add a hero banner derived from the socaity_frontend home hero. No em-dashes,
brand voice and palette.
@luisfilipemed luisfilipemed requested a review from w4hns1nn May 27, 2026 17:53
Replace fabricated text2speech / voice2voice / audio2face / text2image examples
with a real multi-modal pipeline built on socaity.run (deepseek-v3, flux-schnell,
kokoro-82m). Verified live end to end.
Comment thread README.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I never implemented this .run syntax and it looks very stolen from replicate. Have you tested this?

Also something like face2face is not part of the package has nothing to search in this readme.
What about the sentence replicate backed.

The banner is not fitting to the package just use the simple icon.

I don't like this new version I will discard.

@w4hns1nn

w4hns1nn commented Jun 18, 2026

Copy link
Copy Markdown
Collaborator

@luisfilipemed let's take the new icon you made with the small "py" icon on the bottom; and could you do another run of a readme overhaul?

And don't forget to link to the real readme

Comment thread docs/assets/banner.png

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is okay to have a brand header (need to be updated then also somewhen though) I'd make it smaller.
I can't merge this PR because a new syntax was introduced:
cover = socaity.run("black-forest-labs/flux-schnell", prompt="abstract lime on black, minimal")
voice = socaity.run("jaaari/kokoro-82m", text=script, voice="af_bella")

that is not in the socaity-sdk and is not yet planned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants