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.

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

udpated user and developer guides, fixed typos and links #568

Merged
merged 1 commit into from
Jan 24, 2023
Merged

udpated user and developer guides, fixed typos and links #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ai/recommender/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,18 @@ For a new recommender, these two classes, along with the class constructor, must
## Building your own recommender

To build your own recommender, start with the `recommender/base.py` file.
From there, implement `update()` and `recommend()` strategies.
From there, implement `update()` and `recommend()` strategies.
The base class provides `self.ml_p`, a dataframe of available algorithm
configurations.
configurations.
It also maintains a parameter hash table (`self.param_htable`) that facilitates the
unique identification of parameter dictionaries.
Check out the base class API [documentation]() to get started.

unique identification of parameter dictionaries.
Check out the base class API
[documentation](https://epistasislab.github.io/Aliro/api.html) to get started.
To use the recommender with the AI class, you need to make the following changes to
`ai/ai.py`:

1. Import your recommender:

```python
from ai.recommender.my_recommender import MyFancyRecommender
```
Expand Down
Loading