Skip to content

Commit

Permalink
chore: Update README.md file
Browse files Browse the repository at this point in the history
- Make use of cloned repository instead of adding package
- Fix content inside `Visualization`
  • Loading branch information
Ashvith10 authored and Azzaare committed Apr 3, 2023
1 parent 569a9f0 commit 007f9f7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions perf/GLM/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To switch the version of `GLM.jl`:
- Change directory to *../PerfChecker.jl/perf/GLM*
- Access the REPL using `julia -t 10 --project=.`
- Press the `]` key to access the `pkg` REPL
- Run `add GLM@x.y.z`, where x.y.z is the respective major, minor and patch version
- Run `develop <path-to-GLM.jl>`, where GLM.jl is checked out to the required version
- Close the REPL either by coming out of the pkg REPL mode, and executing the `exit()` command, or by using **Ctrl + D**

This should be repeated after every allocation and benchmark checks have run.
Expand All @@ -36,7 +36,7 @@ To run benchmark checks for `GLM.jl`:
#### Visualization

As mentioned before, due to some of the missing features in `PerfChecker.jl`, running checks might be finicky, and the CSV files may produce messed up visualization. To fix the same:
- Make sure that filenames inside `mallocs-x.y.z.csv` do not point to a hash directory, for example, if you see *$HOME/.julia/packages/GLM/<some-hash-value>/src/linpred.jl*, make sure to rewrite it to *$HOME/.julia/packages/GLM/src/linpred.jl*.
- Make sure that filenames inside `mallocs-x.y.z.csv` do not point to a hash directory, for example, if you see *$HOME/.julia/packages/GLM/<some-hash-value>/src/linpred.jl*, make sure to rewrite it to *linpred.jl*.
- Clone `GLM.jl` on your local machine
- Create `perf` directory inside the `GLM.jl` project
- Copy contents of *../PerfChecker.jl/perf/GLM* to the `perf` directory
Expand Down

0 comments on commit 007f9f7

Please sign in to comment.