Skip to content

chore: clean up examples and update README#163

Open
archae0pteryx wants to merge 3 commits intomainfrom
chore/cleanup-examples-and-readme
Open

chore: clean up examples and update README#163
archae0pteryx wants to merge 3 commits intomainfrom
chore/cleanup-examples-and-readme

Conversation

@archae0pteryx
Copy link
Contributor

Summary

  • README overhaul: Remove all EYEPOP_SECRET_KEY references, make EYEPOP_API_KEY the primary auth method, remove EYEPOP_URL row, link to dashboard.eyepop.ai, add full Composable Pops and Data Endpoint documentation sections
  • Remove 4 broken examples that use removed/legacy APIs (visualize_pop.py, visualize_transient.py, load_from_url_timing.py, experimental/import_model_and_alias.py)
  • Fix bugs: live_rtmp_stream.py on_ready positional arg, create_dataset_and_train_sync.py wrong criteria function
  • Update deprecated patterns: model=ability=, modelUuid=abilityUuid= across pop_demo.py and caption_demo.py, EYEPOP_SECRET_KEYEYEPOP_API_KEY in workflow_cli.py
  • Update requirements.txt: bump SDK pin from 3.5 to 3.9, add all missing dependencies

Test plan

  • Verify pop_demo.py runs with --pop person against a live worker
  • Verify caption_demo.py runs with a VLM ability
  • Verify workflow_cli.py authenticates with EYEPOP_API_KEY
  • Verify infer_demo.py runs against a dataset asset
  • Confirm removed examples are no longer referenced anywhere

- Update README: remove EYEPOP_SECRET_KEY references, use EYEPOP_API_KEY
  as primary auth, remove EYEPOP_URL row, link to dashboard.eyepop.ai,
  add Composable Pops and Data Endpoint documentation sections
- Remove broken examples that use removed/legacy APIs:
  visualize_pop.py (load_model doesn't exist),
  visualize_transient.py (set_pop string form removed),
  load_from_url_timing.py (set_pop string form removed),
  experimental/import_model_and_alias.py (typo, missing await, wrong artifact)
- Fix live_rtmp_stream.py: on_ready passed as keyword arg instead of positional
- Update pop_demo.py: model= -> ability=, modelUuid= -> abilityUuid=
- Update caption_demo.py: model= -> ability=
- Update workflow_cli.py: EYEPOP_SECRET_KEY -> EYEPOP_API_KEY
- Fix create_dataset_and_train_sync.py: use correct criteria function
- Update requirements.txt: bump eyepop to ~=3.9, add missing dependencies
- pop_demo.py: fix `dict[str, any]` -> `dict[str, Any]` (lowercase any
  is the builtin function, not a type)
- workflow_cli.py: suppress basedpyright reportFunctionMemberAccess on
  click group command decorators
…rors

Use cast(click.Group, _workflow) so basedpyright resolves .command()
attribute access. Add type annotations to all function signatures.
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.

1 participant