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

async but refactored #1752

Closed
wants to merge 20 commits into from
Closed

async but refactored #1752

wants to merge 20 commits into from

Conversation

technillogue
Copy link
Contributor

@technillogue technillogue commented Jun 19, 2024

this is like #1512, but I squashed and reordered some commits and then rebased onto main

conceptually we could split it up like:

  • the commits up to Mux prediction events (async runner, async predict, minimal async worker). this is uncertain because much but not all of it is fully dropped later
  • httpx
  • AsyncConnection, optimizations, tweak names
  • omnibus actual concurrency
  • remaining async features (emit_metric, time_share_metric, log traceback, batch_size metric)
    however, I don't think we can actually release anything before "actual concurrency", the intermediate commits would likely be broken
    we could alternatively write new code starting with the httpx refactor like you said, or otherwise carve out changes from that branch as new PRs (rather than rebasing the existing commits)

@technillogue technillogue force-pushed the syl/squash-rebase-async branch 5 times, most recently from f7c789b to cf0665b Compare June 20, 2024 20:19
@technillogue technillogue requested a review from mattt July 1, 2024 05:48
Signed-off-by: technillogue <technillogue@gmail.com>
* have runner return asyncio.Task instead of AsyncFuture
* make tests async and fix them
* delete remaining runner thread code :)
* review changes to tests and server

(reverts commit 828eee9)

Signed-off-by: technillogue <technillogue@gmail.com>
this is the first step towards supporting continuous batching and concurrent predictions. eventually, you will be configure it so your predict function will be called concurrently

* bare minimum to support async predict
* add async tests

Signed-off-by: technillogue <technillogue@gmail.com>
Signed-off-by: technillogue <technillogue@gmail.com>
* conditionally create the event loop if predictor is async, and add a path for hypothetical async setup
* don't use async for predict loop if predict is not async
* add test cases for shared loop across setup and predict + asyncio.run in setup

(reverts commit b533c6b)

* lints

Signed-off-by: technillogue <technillogue@gmail.com>
* async Worker._wait and its consequences
* AsyncPipe so that we can process idempotent endpoint and cancellation rather than _wait blocking the event loop
* test_prediction_cancel can be flaky on some machines
* separate _process_list to be less surprising than isasyncgen
* sleep wasn't needed
* suggestions from review
* suggestions from review
* even more suggestions from review

---------

Signed-off-by: technillogue <technillogue@gmail.com>
Co-authored-by: Nick Stenning <nick@whiteink.com>

* format

Signed-off-by: technillogue <technillogue@gmail.com>
* race utility for racing awaitables
* start mux, tag events with id, read pipe in a task, get events from mux
* use async pipe for async child loop
* _shutting_down vs _terminating
* race with shutdown event
* keep reading events during shutdown, but call terminate after the last Done
* emit heartbeats from mux.read
* don't use _wait. instead, setup reads event from the mux too
* worker semaphore and prediction ctx
* where _wait used to raise a fatal error, have _read_events set an error on Mux, and then Mux.read can raise the error in the right context. otherwise, the exception is stuck in a task and doesn't propagate correctly
* fix event loop errors for <3.9
* keep track of predictions in flight explicitly and use that to route logs
* don't wait for executor shutdown
* progress: check for cancelation in task done_handler
* let mux check if child is alive and set mux shutdown after leaving read event loop
* close pipe when exiting
* predict requires IDLE or PROCESSING
* try adding a BUSY state distinct from PROCESSING when we no longer have capacity
* move resetting events to setup() instead of _read_events()

previously this was in _read_events because it's a coroutine that will have the correct event loop. however, _read_events actually gets created in a task, which can run *after* the first mux.read call by setup. since setup is now the first async entrypoint in worker and in tests, we can safely move it there

* state_from_predictions_in_flight instead of checking the value of semaphore
* make prediction_ctx "private"

Signed-off-by: technillogue <technillogue@gmail.com>
* input downloads, output uploads, and webhooks are now handled by ClientManager, which persists for the lifetime of runner, allowing us to reuse connections, which may significantly help with large uploads.
* although I was originally going to drop output_file_prefix, it's not actually hard to maintain. the behavior is changed now and objects are uploaded as soon as they're outputted rather than after the prediction is completed.
* there's an ugly hack with uploading an empty body to get the redirect instead of making api time out from trying to upload an 140GB file. that can be fixed by implemented an MPU endpoint and/or a "fetch upload url" endpoint.
* the behavior of the non-indempotent endpoint is changed; the id is now randomly generated if it's not provided in the body. this isn't strictly required for this change alone, but is hard to carve out.
* the behavior of Path is changed significantly. see https://www.notion.so/replicate/Cog-Setup-Path-Problem-2fc41d40bcaf47579ccd8b2f4c71ee24

Co-authored-by: Mattt <mattt@replicate.com>

* format
* stick a %s on line 190 clients.py (#1707)
* local upload server can be called cluster.local in addition to .internal (#1714)

Signed-off-by: technillogue <technillogue@gmail.com>
* wip

* some tweaks

* ignore some type errors

* test connection roundtrip

* add notes from python source code

Signed-off-by: technillogue <technillogue@gmail.com>
* optimize webhook serialization and logging
* optimize logging by binding structlog proxies
* fix tests

---------

Signed-off-by: technillogue <technillogue@gmail.com>
Signed-off-by: technillogue <technillogue@gmail.com>
* add concurrency to config

* more descriptive names for predict functions

* don't cancel from signal handler if a loop is running. expose worker busy state to runner

* move handle_event_stream to PredictionEventHandler

* make setup and canceling work

* keep track of multiple runner prediction tasks to make idempotent endpoint return the same result and fix tests somewhat

* drop Runner._result, comments

* move create_event_handler into PredictionEventHandler.__init__

* break out Path.validate into value_to_path and inline get_filename and File.validate

* split out URLPath into BackwardsCompatibleDataURLTempFilePath and URLThatCanBeConvertedToPath with the download part of URLFile inlined

* let's make DataURLTempFilePath also use convert and move value_to_path back to Path.validate

* prediction->request

* split up predict/inner/prediction_ctx into enter_predict/exit_predict/prediction_ctx/inner_async_predict/predict/good_predict as one way to do it. however, exposing all of those for runner predict enter/coro exit still sucks, but this is still an improvement

* bigish change: inline predict_and_handle_errors

* inline make_error_handler into setup

* move runner.setup into runner.Runner.setup

* add concurrency to config in go

* try explicitly using prediction_ctx __enter__ and __exit__

* relax setup argument requirement to str

* glom worker into runner

* add logging message

* fix prediction retry and improve logging

* split out handle_event

* use CURL_CA_BUNDLE for file upload

* dubious upload fix

* skip worker and webhook tests since those were erroring on removed imports. fix or xfail runner tests

* validate prediction response to raise errors, but return the unvalidated output to avoid converting urls to File/Path

* expose concurrency in healthcheck

* mediocre logging that works like print

* COG_DISABLE_CANCEL to ignore cancelations

* COG_CONCURRENCY_OVERRIDE

* add ready probe as an http route

* encode webhooks only after knowing they will be sent, and bail our of upload type checks early for strs

* don't validate outputs

* add AsyncConcatenateIterator

* should_exit is not actually used by http

* format

* codecov

* describe the remaining problems with this PR and add comments about cancelation and validation

* add a test

* fix test (#1669)

* fix config schema

* allow setting both max and target concurrency in cog.yaml (#1672)

* drop default_target (#1685)

---------
Signed-off-by: technillogue <technillogue@gmail.com>
Co-authored-by: Mattt <mattt@replicate.com>
* function to emit metrics
* add metrics docs

---------

Signed-off-by: technillogue <technillogue@gmail.com>
predict_time_share tracks the portion of the worker's processing time that was dedicated to each individual prediction. the "cost" of each second is split across the predictions running during that second.

Co-authored-by: Zeke Sikelianos <zeke@sikelianos.com>

predict_time_share needs to be set before sending the completed webhook (#1683)

allow disabling time share metric with COG_DISABLE_TIME_SHARE_METRIC

Signed-off-by: technillogue <technillogue@gmail.com>
* log traceback correctly
* use repr(exception) instead of str(exception) if str(exception) is blank

---------

Signed-off-by: technillogue <technillogue@gmail.com>
Signed-off-by: technillogue <technillogue@gmail.com>
technillogue and others added 4 commits July 18, 2024 15:05
ignore ruff lints added in the new ruff version

Fix broken `make go-test` command

This was due to conflicts in the dependencies

  === Errors
  Error: ../../../go/pkg/mod/github.com/anaskhan96/soup@v1.2.5/soup.go:20:2: missing go.sum entry for module providing package golang.org/x/net/html (imported by github.com/anaskhan96/soup); to add:
  	go get github.com/anaskhan96/soup@v1.2.5
  Error: ../../../go/pkg/mod/github.com/anaskhan96/soup@v1.2.5/soup.go:21:2: missing go.sum entry for module providing package golang.org/x/net/html/charset (imported by github.com/anaskhan96/soup); to add:
  	go get github.com/anaskhan96/soup@v1.2.5

Running `go mod tidy` fixes the issue and this commit contains the
updated go.mod and go.sum files.

Add fixes for ruff issues (#1799)
We have a problem in production where a broken model is not correctly
shutting down when requested, which means that director comes back up,
sees a healthy model (status READY/BUSY) and starts sending it new
predictions, even though it's supposed to be shutting down.

For now, try and improve the situation by poisoning the model
healthcheck on shutdown. This doesn't solve the underlying problem but
it should stop us losing more predictions to a known-broken pod.
Based on the implementation in #1698 for sync cog.

If the request to /predict contains headers `traceparent` and
`tracestate` defined by w3c Trace Context[^1] then these headers are
forwarded on to the webhook and upload calls.

This allows observability systems to link requests passing through cog.

[^1]: https://www.w3.org/TR/trace-context/

Signed-off-by: technillogue <technillogue@gmail.com>
* Cast TraceContext into Mapping[str, str] to fix linter

* Include prediction id upload request

Based on #1667

This PR introduces two small changes to the file upload interface.

1. We now allow downstream services to include the destination of the
asset in a `Location` header, rather than assuming that it's the same as
the final upload url (either the one passed via `--upload-url` or the
result of a 307 redirect response.

2. We now include the `X-Prediction-Id` header in upload request, this
allows the downstream client to potentially do configuration/routing
based on the prediction ID. This ID should be considered unsafe and
needs to be validated by the downstream service.

* Extract ChunkFileReader into top-level class

---------

Co-authored-by: Mattt Zmuda <mattt@replicate.com>
@mattt
Copy link
Member

mattt commented Jul 31, 2024

Closing in favor of #1813

@mattt mattt closed this Jul 31, 2024
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.

None yet

4 participants