Add complete docstrings and typehinting to aepsych python client #664
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary: Pull Request resolved: facebookresearch#663 The python client now runs unittests on Github and lints. New mypy and format check now fails so these are fixed here too. Differential Revision: D70407932
Summary: Tells could handle a lot of different shapes before, we simplify this handling by unifying the shapes to our expected forms. Cases are as follows: * Parameter configuration dictionaries should have keys that are each parameter and the values should be one of a few forms: * * If it's multi stimuli or multi trial (batch) or both, then it must be 2D. The first dimension represents the batch dimension and the second dimension represents the stimuli dimension. * * * If the model is not multi stimuli and only multi trial, we remove the stimuli dimension on converting this to the tensor, otherwise we return batch, dim, stim. * * * If the model is multi stimuli but only has 1 stiim, we assume this is for a prediction and handle it like multi stimuli still with batch, dim stim. * * If it is a single value, it is assumed to be a single trial single stimuli case Batch tells no longer allow a list of configuration dictionaries and instead follow the above case. The pairwise probit now has an additional check to help handle this. Differential Revision: D70285840
Summary: All message handlers return dictionaries now for a consistent api. Differential Revision: D70255834
Summary: Update all docstring and typehints in message handlers to be in line with other parts of the codebase. We use type dicts where possible to directly specify what should be expected. Differential Revision: D70365469
facebook-github-bot
added
the
CLA Signed
|
This pull request was exported from Phabricator. Differential Revision: D70426277 |
|
This pull request was exported from Phabricator. Differential Revision: D70426277 |
JasonKChow
added a commit
to JasonKChow/aepsych
that referenced
this pull request
Mar 1, 2025
…ebookresearch#664) Summary: Pull Request resolved: facebookresearch#664 Updated the aepsych python client to match the rest of the aepsych documentation/type hinting. Differential Revision: D70426277
JasonKChow
force-pushed
the
export-D70426277
branch
from
153d8e7 to
f3afebf
Compare
…ebookresearch#664) Summary: Pull Request resolved: facebookresearch#664 Updated the aepsych python client to match the rest of the aepsych documentation/type hinting. Differential Revision: D70426277
|
This pull request was exported from Phabricator. Differential Revision: D70426277 |
JasonKChow
force-pushed
the
export-D70426277
branch
from
f3afebf to
f8776e1
Compare
|
This pull request has been merged in e894fde. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary: Updated the aepsych python client to match the rest of the aepsych documentation/type hinting.
Differential Revision: D70426277