CarlColglazier/junior-sheer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Create project README

Browse Source
This commit is contained in:
Carl Colglazier 2025-05-23 13:25:18 -05:00
parent c18c9401e9
commit 313edfe994
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# Mastodon Server Recommendation System
## Guideposts
- [manuscripts](/manuscripts/) - Contains the manuscripts for the project.
- [notebooks](/notebooks/) - Notebooks for data exploration and analysis.
- [FediRecommender](/FediRecommender/) - Python package for building and running the recommendation system.
- [codebase](/codebase/) - Place to store shared code.
- [recommender](/recommender/) - Contains the recommendation system code (front-end).
- [presentations](/presentations/) - Slide decks.
- [scripts](/scripts/) - Scripts for data processing and analysis.
## Getting Started
### Environment Setup
This project uses [renv](https://rstudio.github.io/renv/) to manage R package dependencies. To set up the environment, run the following command in R:
```r
renv::restore()
```
This will install all the required packages and their dependencies.