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

Documentation updates #35

Merged
merged 16 commits into from
Jul 15, 2024
Merged

Documentation updates #35

merged 16 commits into from
Jul 15, 2024

Conversation

normandy7
Copy link
Collaborator

@normandy7 normandy7 commented May 22, 2024

  • Tweak phrasing and formatting
  • Move Returns above Example
  • Clarify ObjectState
  • Document StringSet
  • Mention column filtering limit

@normandy7 normandy7 requested a review from Raalsky May 22, 2024 09:42
@normandy7 normandy7 self-assigned this May 22, 2024
README.md Outdated Show resolved Hide resolved
run.prefetch(["parameters/optimizer", "parameter/init_lr"])
# No more calls to the API
print(run["parameters/optimizer"].fetch())
print(run["parameter/init_lr"].fetch())
```

## Available types
## Supported field types
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't remember if we're supporting StringSet, if yes then we should add a section about it as well. @AleksanderWWW would you mind to verify that?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Mentioning string sets was proposed to the internal draft on April 19 following #19 but I see it's not included in the changelog 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

I've checked and looks like we have support for StringSets as well 😉

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

👍🏻 I added a section on line 543

@normandy7 normandy7 requested a review from Raalsky June 27, 2024 09:48
@normandy7 normandy7 changed the title README updates Documentation updates Jul 9, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@normandy7
Copy link
Collaborator Author

To be merged once 0.5.0 is released 🚀 @Raalsky

@Raalsky Raalsky merged commit c5c6c23 into main Jul 15, 2024
7 checks passed
@Raalsky Raalsky deleted the sn/readme-update branch July 15, 2024 19:27
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