Skip to content

Docs #71

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 32 commits into from
Oct 28, 2022
Merged

Docs #71

merged 32 commits into from
Oct 28, 2022

Conversation

shahbuland
Copy link
Contributor

  • Add docstrings to any major objects missing them
  • Add docstrings to configs and data classes
  • Add RTD style documentation

shahbuland and others added 26 commits October 5, 2022 21:56
@shahbuland
Initial docs commit
786f267
@shahbuland
Add extensive docstrings for data types
affe5a9
@shahbuland
Add documentation on configs and data
e181a55
@shahbuland
Add documentation for models
aabed18
@shahbuland
Add documentation for orchestrators
27ba57f
@shahbuland
Add documentation for pipelines
399efd4
@shahbuland
Merge branch 'master' into docs
22446e7
@shahbuland
Resolve missed merge conflict
cdacdc7
@shahbuland
Add docs for ilql
2a50713
@shahbuland
Add some brief documentation on examples present
dff37ae
@shahbuland
update readme with link to docs
31920bb
@shahbuland
Add rtd yml config
8623680
@shahbuland
Remove unneeded/ugly undoc-members
c49af13
@shahbuland
Resolve merge conflicts
6c3fc6e
@shahbuland
Update docs for configs to account for method specific configs
5faa239
@shahbuland
Add docstrings for method configs
a95264c
@shahbuland
Merge branch 'master' into docs
17058e0
@shahbuland
Merge branch 'new-docs' into docs
253ef10
@shahbuland
Move docstring into ModelBranch class
3948328
@shahbuland
Update docs with pipeline and model refactors
32a363f
@shahbuland
Resolve erroneous merge (use updated dataclass attributes from master)
1a13d63
@shahbuland
Remove old file from before merge
af317b7
@shahbuland
Add spacing after docstrings
26f481c
@shahbuland
Update README.md
84310e5
@shahbuland
removed duplicated class method
fe8356b
@shahbuland
Merge branch 'docs' of https://github.com/carperai/trlx into docs
141ed8c
@shahbuland shahbuland marked this pull request as draft October 26, 2022 17:08
@shahbuland shahbuland marked this pull request as ready for review October 27, 2022 22:35
@shahbuland
Copy link
Contributor Author

@thedch Bit confused by results of black. Fixed the simple things, but code-quality test still failing. If you have time, could you take a look and give some pointers on where things are going wrong?

maxreciprocate
maxreciprocate requested changes Oct 28, 2022
View reviewed changes
Copy link
Collaborator

@maxreciprocate maxreciprocate left a comment

Choose a reason for hiding this comment

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

lgtm

@LouisCastricato
Copy link
Contributor

@shahbuland answer the comments and lets merge.

@shahbuland
Copy link
Contributor Author

Have addressed concerns

@LouisCastricato
Copy link
Contributor

Will merge after check passes.

@LouisCastricato LouisCastricato merged commit b623d1b into master Oct 28, 2022
@jon-tow jon-tow deleted the docs branch February 10, 2023 00:26
@jon-tow jon-tow restored the docs branch February 10, 2023 00:26
@jon-tow jon-tow deleted the docs branch February 10, 2023 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxreciprocate maxreciprocate maxreciprocate requested changes

+1 more reviewer

@LouisCastricato LouisCastricato LouisCastricato approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shahbuland @LouisCastricato @maxreciprocate