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

[TLM] Add custom types to docstrings #293

Merged
merged 7 commits into from
Aug 31, 2024
Merged

Conversation

ulya-tkch
Copy link
Collaborator

This change will allow our custom defined types to show up on help.cleanlab.ai here

@jwmueller jwmueller requested a review from jas2600 August 26, 2024 22:05
@jwmueller
Copy link
Member

jwmueller commented Aug 26, 2024

@ulya-tkch I unfortunately don't find the new descriptions super clear either. Perhaps you could first explain everything as if it were just floats or list of floats. And then later in the docstring say:

Actually instead of float, this may be a TLMScore object if ... (important to specify when the returned object might not be a float / the simpler return type, and what the type of the returned object would be in those scenarios).

Will leave reviews of this to @jas2600

But encourage you to write as simply and clearly as you can.

@ulya-tkch
Copy link
Collaborator Author

MAX_PROMPT_LENGTH_TOKENS needs to be increased for TLM unit tests to start passing again.

Copy link
Contributor

@jas2600 jas2600 left a comment

Choose a reason for hiding this comment

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

two small suggested changes, otherwise LGTM

cleanlab_studio/studio/trustworthy_language_model.py Outdated Show resolved Hide resolved
cleanlab_studio/studio/trustworthy_language_model.py Outdated Show resolved Hide resolved
@ulya-tkch ulya-tkch merged commit 8bb7ca7 into main Aug 31, 2024
25 checks passed
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