uniadmintools.jl
Optimisation tools for academic administrative duties
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary
Repository
Optimisation tools for academic administrative duties
Basic Info
- Host: GitHub
- Owner: MilesCranmer
- License: apache-2.0
- Language: Julia
- Default Branch: master
- Homepage: http://astroautomata.com/UniAdminTools.jl/
- Size: 341 KB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
UniAdminTools
Optimisation tools for academic administrative duties:
- Aggregation of sparse committee scores of {job candidates,proposals,...} with
mergescore- Accounts for sparsity, noise, uncertainty, and different scoring scales among committee members
- Bayesian inference scheme using TuringLang with DynamicHMC for sampling
- Allocating projects among students with
projalloc
Installation
First, you need to install Julia:
bash
curl -fsSL https://install.julialang.org | sh
Which will install it interactively. For Windows machines, you can use winget install julia -s msstore.
Then, install this package and all dependencies with:
bash
julia -e 'using Pkg; pkg"add https://github.com/MilesCranmer/UniAdminTools.jl"'
This should create some binaries in your ~/.julia/bin folder that can be executed.
Make sure to put that folder in your PATH environment variable.
Usage
Usage for the CLI interface is provided below. You can also find this on astroautomata.com/UniAdminTools.jl/dev.
mergescore
text
mergescore input
[--sheet-name SHEET_NAME]
[--scorer-range SCORER_RANGE]
[--candidate-range CANDIDATE_RANGE]
[--data-range DATA_RANGE]
[--output "candidate_info.csv"]
[--scorer-info "scorer_info.csv"]
[--n-chains 6]
[--n-samples 2000]
[--n-adapts 500]
[--sampler "NUTS()"]
[--lower-true-score 1.0]
[--upper-true-score 10.0]
[--mean-bias 0.0]
[--stdev-bias 1.0]
[--mean-scale 1.0]
[--stdev-scale 0.3]
[--silent]
Estimate true scores of candidates from sparse observations by committee members.
Args
input: A csv or xlsx file with candidates and committee scores (default is between 1 and 10), with unranked candidate-scorer pairs left blank.
Options
--sheet-name: If anxlsxfile is passed, the name of the sheet to read from (such as"Sheet 1").--scorer-range: If anxlsxfile is passed, the range of cells containing the names of the scorers (such as"A2:A10").--candidate-range: If anxlsxfile is passed, the range of cells containing the names of the candidates (such as"B1:J1").--data-range: If anxlsxfile is passed, the range of cells containing the scores of the candidates (such as"B2:J10").--output <"candidate_info.csv">: The name of the (csv) file to write the estimated scores to.--scorer-info <"scorer_info.csv">: The name of the file to write the estimated biases and scales of the scorers to.--n-chains <6::Int>: The number of chains to run.--n-samples <2000::Int>: The number of samples to draw from each chain.--n-adapts <500::Int>: The number of samples to use for warming up.--sampler <"NUTS()"::String>: The sampler to use. Can be, for example,"NUTS()"or"SMC()".--lower-true-score <1.0::Float64>: The lower bound of the uniform prior on the true scores.--upper-true-score <10.0::Float64>: The upper bound of the uniform prior on the true scores.--mean-bias <0.0::Float64>: The mean of the normal prior on the bias of the scorers.--stdev-bias <1.0::Float64>: The standard deviation of the normal prior on the bias of the scorers.--mean-scale <1.0::Float64>: The mean of the normal prior on the scale of the scorers.--stdev-scale <0.3::Float64>: The standard deviation of the normal prior on the scale of the scorers.
Flags
--silent: Whether to suppress output.
Example
Say we put all the data into a file data.csv:
csv
candidates,Scorer AA,BB,DD,FF,HH,LL,MM
Candidate 1,,7.9,,8.5,8.2,8.4,
Candidate 2,4.2,7.4,3.7,,,,2.8
Candidate 3,,4.4,,5.2,5.7,,5.2
Candidate First name Last name,9.6,,7.6,,8,,
Candidate 5,,,,,,,,,
We can then create estimates for true scores with:
bash
mergescore data.csv --n-chains 5 --n-samples 3000 --output my_output.csv
This will create a file my_output.csv with estimates for true
scores of each candidate.
projalloc
text
projalloc --choices CHOICES
--projects PROJECTS
[--output "project_allocations.csv"]
[--overall_objective "happiness - 0.5 * load"]
[--rank_to_happiness "10 - 2^(ranking - 1) + 1"]
[--assignments_to_load "num_assigned^2"]
[--optimizer_time_limit 5]
[--max_students_per_project 4]
[--max_students_per_teacher 12]
[--silent]
Compute optimal project allocations for student projects, using two csv files.
Options
--choices: A csv file with no header (data starting at the first row). The first column should be the student name, and the rest should be project choices (integer).--projects: A csv file with no header (data starting at the first row). The first column should be the teacher name, and the second column should be the project name.--output <"project_allocations.csv"::String>: The filename to save the output to.--overall_objective <"happiness - 0.5 * load"::String>: A function that takes the total happiness and the total load and returns a single number. This will be maximized.--rank_to_happiness <"10 - 2^(ranking - 1) + 1"::String>: Convert a student-assigned ranking into ahappiness, which will be summed over students.--assignments_to_load <"num_assigned^2"::String>: A function that takes the number of students assigned to each project and returns a number. This will be summed over projects.--optimizer_time_limit <5::Int>: How long to spend optimizing the project allocations. Should usually find it pretty quickly (within 5 seconds), but you might try increasing this to see if it changes the results.--max_students_per_project <4::Int>: The maximum number of students that can be assigned to a project.--max_students_per_teacher <12::Int>: The maximum number of students that can be assigned to a teacher.
Flags
--silent: Don't print out information about the optimization process.
Examples
Say that we create a file choices.csv with student preferences (first column is student name,
second column is first choice, third column is second choice, etc.):
csv
"Student A",1,2,4
"Student B",1,3,4
"Student C",5,3,4
"Student D",6,1,2
and then another file projects.csv with project listings (first column is teacher name,
second column is project name):
csv
"Teacher A","Project A1"
"Teacher A","Project A2"
"Teacher B","B 3"
"Teacher C","C4"
"Teacher D","D project 1"
"Teacher D","D project 2"
"Teacher D","D project 3"
Note that the order of the projects here is used to set the index of each project. This is used for matching integers with the student preferences file.
Then we can run the following command:
bash
projalloc --choices choices.csv --projects projects.csv \
--output allocations.csv \
--overall-objective "happiness - 0.5 * load"
which will create a csv file allocations.csv with
an optimal allocation of student projects.
Owner
- Name: Miles Cranmer
- Login: MilesCranmer
- Kind: user
- Location: Cambridge, UK
- Company: University of Cambridge
- Website: astroautomata.com
- Twitter: MilesCranmer
- Repositories: 219
- Profile: https://github.com/MilesCranmer
Assistant Professor at University of Cambridge. Works on AI for the physical sciences.
Citation (CITATION.bib)
@misc{UniAdminTools.jl,
author = {Miles Cranmer and contributors},
title = {UniAdminTools.jl},
url = {https://github.com/MilesCranmer/UniAdminTools.jl},
version = {v1.0.0-DEV},
year = {2023},
month = {12}
}
GitHub Events
Total
- Push event: 9
- Create event: 246
Last Year
- Push event: 9
- Create event: 246
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- coverallsapp/github-action master composite
- julia-actions/cache v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-docdeploy v1 composite
- julia-actions/setup-julia v1 composite
- JuliaRegistries/TagBot v1 composite