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

Simulation userguide #172

Merged
merged 4 commits into from
Mar 19, 2024
Merged

Simulation userguide #172

merged 4 commits into from
Mar 19, 2024

Conversation

AVHopp
Copy link
Collaborator

@AVHopp AVHopp commented Mar 13, 2024

This PR introduces a user guide for BayBE's simulation capabilities. It briefly introduces the core concepts like lookup and the different kinds of simulation available.

Note that this PR was not designed to be perfect and final. Since there might or might not be an upcoming refactoring of the simulation capabilities, the goal of this PR was to have some reasonable user guide, not a perfect one.

In addition, I realized that there was no example using the simulate_transfer_learning function so far. I consequently added one example and called it "Cross Task Learning" as this was the best description I could find. The example is heavily based on the other Transfer Learning example.

@AVHopp AVHopp self-assigned this Mar 13, 2024
@AVHopp AVHopp added the documentation Improvements or additions to documentation label Mar 13, 2024
Copy link
Collaborator

@Scienfitz Scienfitz left a comment

Choose a reason for hiding this comment

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

i think the user guide is great and more than enough for the hackathon
not sure about the example

docs/userguide/simulation.md Outdated Show resolved Hide resolved
docs/userguide/simulation.md Outdated Show resolved Hide resolved
docs/userguide/simulation.md Show resolved Hide resolved
docs/userguide/simulation.md Outdated Show resolved Hide resolved
docs/userguide/simulation.md Outdated Show resolved Hide resolved
docs/userguide/simulation.md Outdated Show resolved Hide resolved
docs/userguide/simulation.md Outdated Show resolved Hide resolved
docs/userguide/simulation.md Outdated Show resolved Hide resolved
examples/Transfer_Learning/cross_task_learning.py Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@AVHopp AVHopp force-pushed the docs/simulation_userguide branch from 847e083 to 984830d Compare March 14, 2024 14:38
@AVHopp AVHopp force-pushed the docs/simulation_userguide branch from 984830d to 7e1a6a4 Compare March 17, 2024 14:35
@AVHopp AVHopp force-pushed the docs/simulation_userguide branch from 7e1a6a4 to 238d955 Compare March 19, 2024 09:49
@AVHopp AVHopp merged commit 7397f03 into main Mar 19, 2024
10 checks passed
@AVHopp AVHopp deleted the docs/simulation_userguide branch March 19, 2024 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants