add cores documentation

pachadotdev · Aug 10, 2024 · bc374ea · bc374ea
1 parent 674595d
commit bc374ea
Show file tree

Hide file tree

Showing 20 changed files with 150 additions and 30 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -125,13 +125,34 @@ Memory allocation for the same models
 | **Capybara** |    27MB |            32MB |        20MB |              23MB |                       29MB |          43MB |
 | Fixest       |    44MB |            36MB |        27MB |              32MB |                       41MB |          63MB |
 
-# Debugging
+## Changing the number of cores
 
-I run `r_valgrind "dev/test_get_alpha.r"` or the corresponding test from the
-project's root in a new terminal (bash).
+Note that you can edit the `Makevars` file to change the number of cores that
+capybara uses, here is an example of how it affects the performance
+
+| cores |   PPML | Trade Diversion  | Endogeneity | Reverse Causality | Non-linear/Phasing Effects | Globalization |
+|:------|-------:|-----------------:|------------:|------------------:|---------------------------:|--------------:|
+| 2     |   1.8s |            16.2s |        7.7s |              9.6s |                      13.0s |         24.0s |
+| 4     |   1.7s |            16.0s |        7.4s |              9.3s |                      12.3s |         23.6s |
+| 6     |   0.7s |             2.4s |        2.0s |              2.0s |                       2.5s |          4.0s |
+| 8     |   0.3s |             2.0s |        1.2s |              1.4s |                       1.7s |          3.4s |
+
+## Testing and debugging
+
+## Testing
+
+I use `testthat` (e.g., `devtools::test()`) to compare the results with base R.
+These tests are about the correctness of the results.
+
+### Debuging
+
+I run `r_valgrind "dev/valgrind-kendall-correlation.r"` or the corresponding
+test from the project's root in a new terminal (bash) after running
+`devtools::install()`. These tests are about memory leaks (e.g., I use
+repeteated computations and sometimes things such as "pi = 3").
 
 This works because I previously defined this in `.bashrc`, to make it work you
-need to run `source ~/.bashrc` or reboot:
+need to run `source ~/.bashrc` or reboot your computer.
 
 ```
 function r_debug_symbols () {
@@ -209,4 +230,6 @@ When you are ready testing, you need to remove `-UDEBUG` from `src/Makevars`.
 
 ## Code of Conduct
 
-Please note that the capybara project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
+Please note that the capybara project is released with a
+[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
+By contributing to this project, you agree to abide by its terms.
diff --git a/README.md b/README.md
@@ -118,13 +118,35 @@ Memory allocation for the same models
 | **Capybara** |   27MB |            32MB |        20MB |              23MB |                       29MB |          43MB |
 | Fixest       |   44MB |            36MB |        27MB |              32MB |                       41MB |          63MB |
 
-# Debugging
+## Changing the number of cores
 
-I run `r_valgrind "dev/test_get_alpha.r"` or the corresponding test from
-the project’s root in a new terminal (bash).
+Note that you can edit the `Makevars` file to change the number of cores
+that capybara uses, here is an example of how it affects the performance
+
+| cores | PPML | Trade Diversion | Endogeneity | Reverse Causality | Non-linear/Phasing Effects | Globalization |
+| :---- | ---: | --------------: | ----------: | ----------------: | -------------------------: | ------------: |
+| 2     | 1.8s |           16.2s |        7.7s |              9.6s |                      13.0s |         24.0s |
+| 4     | 1.7s |           16.0s |        7.4s |              9.3s |                      12.3s |         23.6s |
+| 6     | 0.7s |            2.4s |        2.0s |              2.0s |                       2.5s |          4.0s |
+| 8     | 0.3s |            2.0s |        1.2s |              1.4s |                       1.7s |          3.4s |
+
+## Testing and debugging
+
+## Testing
+
+I use `testthat` (e.g., `devtools::test()`) to compare the results with
+base R. These tests are about the correctness of the results.
+
+### Debuging
+
+I run `r_valgrind "dev/valgrind-kendall-correlation.r"` or the
+corresponding test from the project’s root in a new terminal (bash)
+after running `devtools::install()`. These tests are about memory leaks
+(e.g., I use repeteated computations and sometimes things such as “pi =
+3”).
 
 This works because I previously defined this in `.bashrc`, to make it
-work you need to run `source ~/.bashrc` or reboot:
+work you need to run `source ~/.bashrc` or reboot your computer.
 
     function r_debug_symbols () {
         # if src/Makevars does not exist, exit

diff --git a/dev/benchmarks_tests_agtpa_capybara_only.R b/dev/benchmarks_tests_agtpa_capybara_only.R
@@ -1,7 +1,7 @@
 # this is not just about speed/memory, but also about obtaining the same
 # slopes as in base R
 
-library(capybara)
+devtools::load_all()
 library(dplyr)
 library(tidyr)
 library(janitor)

diff --git a/dev/get_index_list.cpp → ...that_i_might_use_later/get_index_list.cpp b/dev/get_index_list.cpp → ...that_i_might_use_later/get_index_list.cpp
diff --git a/dev/test-get_index_list.R → ...t_i_might_use_later/test-get_index_list.R b/dev/test-get_index_list.R → ...t_i_might_use_later/test-get_index_list.R
diff --git a/dev/cudata.rds → dev/replication/cudata.rds b/dev/cudata.rds → dev/replication/cudata.rds
diff --git a/dev/currency_unions_tidy.r → dev/replication/currency_unions_tidy.r b/dev/currency_unions_tidy.r → dev/replication/currency_unions_tidy.r
diff --git a/dev/valgrind-kendall-correlation.r b/dev/valgrind-kendall-correlation.r
@@ -0,0 +1,9 @@
+# this is also tested in /tests
+
+set.seed(123)
+x <- rnorm(100)
+y <- rpois(100, 2)
+
+for (i in 1:100) {
+  kendall_cor(x, y)
+}
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,5 +3,5 @@ pkgdown: 2.0.7
 pkgdown_sha: ~
 articles:
   intro: intro.html
-last_built: 2024-08-08T15:09Z
+last_built: 2024-08-10T20:44Z
 
diff --git a/docs/reference/apes.html b/docs/reference/apes.html
diff --git a/docs/reference/bias_corr.html b/docs/reference/bias_corr.html
diff --git a/docs/reference/feglm.html b/docs/reference/feglm.html
diff --git a/docs/reference/felm.html b/docs/reference/felm.html
diff --git a/docs/reference/fenegbin.html b/docs/reference/fenegbin.html
diff --git a/docs/reference/fepoisson.html b/docs/reference/fepoisson.html
diff --git a/src/00_main.h b/src/00_main.h
@@ -4,7 +4,7 @@
 #include <cmath>
 #include <cpp11.hpp>
 #include <numeric>
-#include <r_armadillo_bindings.hpp>
+#include <cpp11armadillo.hpp>
 #include <vector>
 
 // #include <iostream>

diff --git a/src/06_glm_offset_fit.cpp b/src/06_glm_offset_fit.cpp
@@ -30,7 +30,6 @@ feglm_offset_fit_(const doubles &eta_r, const doubles &y_r,
   const int n = y.n_elem;
   Col<double> mu_eta(n), yadj(n);
   Mat<double> w(n, 1);
-  bool conv = false;
 
   bool dev_crit, val_crit, imp_crit;
   double dev_old, dev_ratio, dev_ratio_inner, rho;
@@ -90,7 +89,6 @@ feglm_offset_fit_(const doubles &eta_r, const doubles &y_r,
     dev_ratio = fabs(dev - dev_old) / (0.1 + fabs(dev));
 
     if (dev_ratio < dev_tol) {
-      conv = true;
       break;
     }
 

diff --git a/src/Makevars b/src/Makevars
@@ -1,2 +1,2 @@
-PKG_CXXFLAGS = $(SHLIB_OPENMP_CXXFLAGS) 
+PKG_CXXFLAGS = $(SHLIB_OPENMP_CXXFLAGS) -DARMA_OPENMP_THREADS=8
 PKG_LIBS = $(SHLIB_OPENMP_CXXFLAGS) $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS)
diff --git a/src/Makevars.win b/src/Makevars.win
@@ -1,2 +1,2 @@
-PKG_CXXFLAGS = $(SHLIB_OPENMP_CXXFLAGS) 
+PKG_CXXFLAGS = $(SHLIB_OPENMP_CXXFLAGS) -DARMA_OPENMP_THREADS=8
 PKG_LIBS = $(SHLIB_OPENMP_CXXFLAGS) $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS)