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

QoL improvements and more docs #126

Merged
merged 16 commits into from
May 8, 2024
Merged

QoL improvements and more docs #126

merged 16 commits into from
May 8, 2024

Conversation

bengioe
Copy link
Collaborator

@bengioe bengioe commented Mar 11, 2024

This PR is (unfortunately) fairly massive, but is mostly renaming things, or removing things that aren't needed anymore.

  • Updated README.md
    • Added docs/contributing.md and docs/getting_started.md
    • Added (a link to) an introductory notebook, runnable on colab
  • Renamed FlatRewards into ObjectProperties, as well as related function names
  • Renamed RewardScalar into either LogScalar or LinScalar, as well as changed the function signature of functions accordingly
  • Removed all passing around of rng instances, replaced by get_worker_rng to remove any confusion around worker seeding
    • Similarly, dev should now be acquired via get_worker_device
  • None-proofed cond_info in models. There should now be a sensible default behavior. Eventually we should properly make sure the code support unconditional tasks
  • Made cfg.git_hash computational conditional on being in a git repo
  • Renamed generic functions and methods working with objects to obj[s] rather than mol[s]
  • Made terminate close log files (to avoid issues when a single process runs multiple trials)
  • Added a read_all_results function in sqlite_log.py. This is probably the fastest way to load log data
  • Fixed a number of mypy issues.

@bengioe bengioe marked this pull request as ready for review March 20, 2024 16:23
Copy link
Contributor

@julienroyd julienroyd left a comment

Choose a reason for hiding this comment

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

LGTM!

@bengioe bengioe merged commit f106cde into trunk May 8, 2024
4 checks passed
@bengioe bengioe deleted the bengioe-qol-and-docs branch May 8, 2024 21:32
@bengioe bengioe mentioned this pull request May 27, 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.

2 participants