GBNLPOLYIT(1)

📦
version 6.3 · 2 versions
  • 6.3 · debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 6.0 · ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 GBNLPOLYIT — bestie edition 💖

okay so first things first: this is a User Command, manual section 1, and its whole government name is gbnlpolyit. Say it with me. slay. 🎀

✨ NAME ✨

gbnlpolyit — Non linear polyit regression 🦋

✨ SYNOPSIS ✨

gbnlpolyit [options] <function definition>

that's it. that's the whole vibe. <function definition> is literally required, don't ghost it. 💅

✨ DESCRIPTION ✨

Non linear polyit estimation. The whole point is minimizing the negative log-likelihood, and there are two flavors depending on which specification you're on. 🍓

For the Polya specification, minimize:

sum_{h=0}^{L-1} log(A+h) - sum_{l=1}^L sum_{h=0}^{n_l-1}
log(a_l+h)

For the multinomial specification, minimize:

L log(A) - sum_{l=1}^L n_l log(a_l)

where A = sum_{l=1}^L a_l and L is the number of alternatives. (the way L is just. the number of alternatives. iconic.) 👑

Now, about your input data file, bestie, listen up: it should contain L rows, one for each alternative, and each row goes n x1 ... XN. The first column is the dependent variable — that's the # of observations, no cap — and the other columns are the independent variables. 🌸

The model itself is specified by a function a_l=g(x1,x2...) where x1,.. XN stands for the first, second .. N-th column of independent variables. got it? got it. 💜

✨ OPTIONS ✨

  • -O — type of output (default 0)
    • 0 — parameters and log-like (ll)
    • 1 — marginal effects
    • 2 — marginal elasticities
    • 3 — n_l n*_l a*_l *=estimated
    • 4 — occupancies classes
  • -F — input fields separators (default " \t") 🔥
  • -V — standard errors and p-scores of diff. from zero using bootstrap
  • -r — number of replicas (default 20)
  • -v — verbosity level (default 0)
    • 0 — just results
    • 1 — comment headers
    • 2 — summary statistics
    • 3 — covariance matrix
    • 4 — minimization steps
    • 5 — model definition
  • -R — set the rng seed (default 0) 🎲
  • -M — set the model to use (default 0)
    • 0 — Polya
    • 1 — multinomial
  • -A — MLL optimization options (default 0.01,0.1,100,1e-6,1e-6,5). fields are step,tol,iter,eps,msize,algo. Empty fields for default ✨
    • step — initial step size of the searching algorithm
    • tol — line search tolerance
    • iter — maximum number of iterations
    • eps — gradient tolerance : stopping criteria ||gradient||<eps
    • algo — optimization methods: 0 Fletcher-Reeves, 1 Polak-Ribiere, 2 Broyden-Fletcher-Goldfarb-Shanno, 3 Steepest descent, 4 simplex, 5 Broyden-Fletcher-Goldfarb-Shanno-2
note bestie: -A wants its fields in that exact order, and if you leave a field empty it just falls back to the default. empty fields = default, that's the rule. 🙈

✨ AUTHOR ✨

Written by Giulio Bottazzi 🫶

✨ REPORTING BUGS ✨

found a bug? not the moment to be shy, tell them: <gbutils@googlegroups.com> 😭

Package home page: <http://cafim.sssup.it/~giulio/software/gbutils/index.html> 🌈

Copyright © 2001-2018 Giulio Bottazzi

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License (version 2) as published by the Free Software Foundation; 💖

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. ⚠️

okay and the lil sign-off: this is gbnlpolyit version 6.2, and the page is dated June 2021. that's the whole manual, bestie, go minimize some negative log-likelihood, you're gonna ate 💅✨💖

📦 where this page comes from