repo
stringlengths
7
55
path
stringlengths
4
127
func_name
stringlengths
1
88
original_string
stringlengths
75
19.8k
language
stringclasses
1 value
code
stringlengths
75
19.8k
code_tokens
list
docstring
stringlengths
3
17.3k
docstring_tokens
list
sha
stringlengths
40
40
url
stringlengths
87
242
partition
stringclasses
1 value
jazzband/django-model-utils
model_utils/managers.py
SoftDeletableManagerMixin.get_queryset
def get_queryset(self): """ Return queryset limited to not removed entries. """ kwargs = {'model': self.model, 'using': self._db} if hasattr(self, '_hints'): kwargs['hints'] = self._hints return self._queryset_class(**kwargs).filter(is_removed=False)
python
def get_queryset(self): """ Return queryset limited to not removed entries. """ kwargs = {'model': self.model, 'using': self._db} if hasattr(self, '_hints'): kwargs['hints'] = self._hints return self._queryset_class(**kwargs).filter(is_removed=False)
[ "def", "get_queryset", "(", "self", ")", ":", "kwargs", "=", "{", "'model'", ":", "self", ".", "model", ",", "'using'", ":", "self", ".", "_db", "}", "if", "hasattr", "(", "self", ",", "'_hints'", ")", ":", "kwargs", "[", "'hints'", "]", "=", "self...
Return queryset limited to not removed entries.
[ "Return", "queryset", "limited", "to", "not", "removed", "entries", "." ]
d557c4253312774a7c2f14bcd02675e9ac2ea05f
https://github.com/jazzband/django-model-utils/blob/d557c4253312774a7c2f14bcd02675e9ac2ea05f/model_utils/managers.py#L295-L303
train
jazzband/django-model-utils
model_utils/tracker.py
FieldInstanceTracker.previous
def previous(self, field): """Returns currently saved value of given field""" # handle deferred fields that have not yet been loaded from the database if self.instance.pk and field in self.deferred_fields and field not in self.saved_data: # if the field has not been assigned locall...
python
def previous(self, field): """Returns currently saved value of given field""" # handle deferred fields that have not yet been loaded from the database if self.instance.pk and field in self.deferred_fields and field not in self.saved_data: # if the field has not been assigned locall...
[ "def", "previous", "(", "self", ",", "field", ")", ":", "# handle deferred fields that have not yet been loaded from the database", "if", "self", ".", "instance", ".", "pk", "and", "field", "in", "self", ".", "deferred_fields", "and", "field", "not", "in", "self", ...
Returns currently saved value of given field
[ "Returns", "currently", "saved", "value", "of", "given", "field" ]
d557c4253312774a7c2f14bcd02675e9ac2ea05f
https://github.com/jazzband/django-model-utils/blob/d557c4253312774a7c2f14bcd02675e9ac2ea05f/model_utils/tracker.py#L142-L160
train
jazzband/django-model-utils
model_utils/tracker.py
FieldTracker.get_field_map
def get_field_map(self, cls): """Returns dict mapping fields names to model attribute names""" field_map = dict((field, field) for field in self.fields) all_fields = dict((f.name, f.attname) for f in cls._meta.fields) field_map.update(**dict((k, v) for (k, v) in all_fields.items() ...
python
def get_field_map(self, cls): """Returns dict mapping fields names to model attribute names""" field_map = dict((field, field) for field in self.fields) all_fields = dict((f.name, f.attname) for f in cls._meta.fields) field_map.update(**dict((k, v) for (k, v) in all_fields.items() ...
[ "def", "get_field_map", "(", "self", ",", "cls", ")", ":", "field_map", "=", "dict", "(", "(", "field", ",", "field", ")", "for", "field", "in", "self", ".", "fields", ")", "all_fields", "=", "dict", "(", "(", "f", ".", "name", ",", "f", ".", "at...
Returns dict mapping fields names to model attribute names
[ "Returns", "dict", "mapping", "fields", "names", "to", "model", "attribute", "names" ]
d557c4253312774a7c2f14bcd02675e9ac2ea05f
https://github.com/jazzband/django-model-utils/blob/d557c4253312774a7c2f14bcd02675e9ac2ea05f/model_utils/tracker.py#L202-L208
train
jazzband/django-model-utils
model_utils/models.py
add_status_query_managers
def add_status_query_managers(sender, **kwargs): """ Add a Querymanager for each status item dynamically. """ if not issubclass(sender, StatusModel): return if django.VERSION >= (1, 10): # First, get current manager name... default_manager = sender._meta.default_manager ...
python
def add_status_query_managers(sender, **kwargs): """ Add a Querymanager for each status item dynamically. """ if not issubclass(sender, StatusModel): return if django.VERSION >= (1, 10): # First, get current manager name... default_manager = sender._meta.default_manager ...
[ "def", "add_status_query_managers", "(", "sender", ",", "*", "*", "kwargs", ")", ":", "if", "not", "issubclass", "(", "sender", ",", "StatusModel", ")", ":", "return", "if", "django", ".", "VERSION", ">=", "(", "1", ",", "10", ")", ":", "# First, get cur...
Add a Querymanager for each status item dynamically.
[ "Add", "a", "Querymanager", "for", "each", "status", "item", "dynamically", "." ]
d557c4253312774a7c2f14bcd02675e9ac2ea05f
https://github.com/jazzband/django-model-utils/blob/d557c4253312774a7c2f14bcd02675e9ac2ea05f/model_utils/models.py#L60-L83
train
jazzband/django-model-utils
model_utils/models.py
add_timeframed_query_manager
def add_timeframed_query_manager(sender, **kwargs): """ Add a QueryManager for a specific timeframe. """ if not issubclass(sender, TimeFramedModel): return if _field_exists(sender, 'timeframed'): raise ImproperlyConfigured( "Model '%s' has a field named 'timeframed' " ...
python
def add_timeframed_query_manager(sender, **kwargs): """ Add a QueryManager for a specific timeframe. """ if not issubclass(sender, TimeFramedModel): return if _field_exists(sender, 'timeframed'): raise ImproperlyConfigured( "Model '%s' has a field named 'timeframed' " ...
[ "def", "add_timeframed_query_manager", "(", "sender", ",", "*", "*", "kwargs", ")", ":", "if", "not", "issubclass", "(", "sender", ",", "TimeFramedModel", ")", ":", "return", "if", "_field_exists", "(", "sender", ",", "'timeframed'", ")", ":", "raise", "Impr...
Add a QueryManager for a specific timeframe.
[ "Add", "a", "QueryManager", "for", "a", "specific", "timeframe", "." ]
d557c4253312774a7c2f14bcd02675e9ac2ea05f
https://github.com/jazzband/django-model-utils/blob/d557c4253312774a7c2f14bcd02675e9ac2ea05f/model_utils/models.py#L86-L102
train
invoice-x/invoice2data
src/invoice2data/input/tesseract4.py
to_text
def to_text(path, language='fra'): """Wraps Tesseract 4 OCR with custom language model. Parameters ---------- path : str path of electronic invoice in JPG or PNG format Returns ------- extracted_str : str returns extracted text from image in JPG or PNG format """ i...
python
def to_text(path, language='fra'): """Wraps Tesseract 4 OCR with custom language model. Parameters ---------- path : str path of electronic invoice in JPG or PNG format Returns ------- extracted_str : str returns extracted text from image in JPG or PNG format """ i...
[ "def", "to_text", "(", "path", ",", "language", "=", "'fra'", ")", ":", "import", "subprocess", "from", "distutils", "import", "spawn", "import", "tempfile", "import", "time", "# Check for dependencies. Needs Tesseract and Imagemagick installed.", "if", "not", "spawn", ...
Wraps Tesseract 4 OCR with custom language model. Parameters ---------- path : str path of electronic invoice in JPG or PNG format Returns ------- extracted_str : str returns extracted text from image in JPG or PNG format
[ "Wraps", "Tesseract", "4", "OCR", "with", "custom", "language", "model", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/input/tesseract4.py#L2-L69
train
invoice-x/invoice2data
src/invoice2data/input/gvision.py
to_text
def to_text(path, bucket_name='cloud-vision-84893', language='fr'): """Sends PDF files to Google Cloud Vision for OCR. Before using invoice2data, make sure you have the auth json path set as env var GOOGLE_APPLICATION_CREDENTIALS Parameters ---------- path : str path of electronic invo...
python
def to_text(path, bucket_name='cloud-vision-84893', language='fr'): """Sends PDF files to Google Cloud Vision for OCR. Before using invoice2data, make sure you have the auth json path set as env var GOOGLE_APPLICATION_CREDENTIALS Parameters ---------- path : str path of electronic invo...
[ "def", "to_text", "(", "path", ",", "bucket_name", "=", "'cloud-vision-84893'", ",", "language", "=", "'fr'", ")", ":", "\"\"\"OCR with PDF/TIFF as source files on GCS\"\"\"", "import", "os", "from", "google", ".", "cloud", "import", "vision", "from", "google", ".",...
Sends PDF files to Google Cloud Vision for OCR. Before using invoice2data, make sure you have the auth json path set as env var GOOGLE_APPLICATION_CREDENTIALS Parameters ---------- path : str path of electronic invoice in JPG or PNG format bucket_name : str name of bucket to us...
[ "Sends", "PDF", "files", "to", "Google", "Cloud", "Vision", "for", "OCR", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/input/gvision.py#L2-L83
train
invoice-x/invoice2data
src/invoice2data/output/to_csv.py
write_to_file
def write_to_file(data, path): """Export extracted fields to csv Appends .csv to path if missing and generates csv file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated csv file ...
python
def write_to_file(data, path): """Export extracted fields to csv Appends .csv to path if missing and generates csv file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated csv file ...
[ "def", "write_to_file", "(", "data", ",", "path", ")", ":", "if", "path", ".", "endswith", "(", "'.csv'", ")", ":", "filename", "=", "path", "else", ":", "filename", "=", "path", "+", "'.csv'", "if", "sys", ".", "version_info", "[", "0", "]", "<", ...
Export extracted fields to csv Appends .csv to path if missing and generates csv file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated csv file Notes ---- Do give file na...
[ "Export", "extracted", "fields", "to", "csv" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/output/to_csv.py#L5-L54
train
invoice-x/invoice2data
src/invoice2data/input/tesseract.py
to_text
def to_text(path): """Wraps Tesseract OCR. Parameters ---------- path : str path of electronic invoice in JPG or PNG format Returns ------- extracted_str : str returns extracted text from image in JPG or PNG format """ import subprocess from distutils import sp...
python
def to_text(path): """Wraps Tesseract OCR. Parameters ---------- path : str path of electronic invoice in JPG or PNG format Returns ------- extracted_str : str returns extracted text from image in JPG or PNG format """ import subprocess from distutils import sp...
[ "def", "to_text", "(", "path", ")", ":", "import", "subprocess", "from", "distutils", "import", "spawn", "# Check for dependencies. Needs Tesseract and Imagemagick installed.", "if", "not", "spawn", ".", "find_executable", "(", "'tesseract'", ")", ":", "raise", "Environ...
Wraps Tesseract OCR. Parameters ---------- path : str path of electronic invoice in JPG or PNG format Returns ------- extracted_str : str returns extracted text from image in JPG or PNG format
[ "Wraps", "Tesseract", "OCR", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/input/tesseract.py#L4-L38
train
invoice-x/invoice2data
src/invoice2data/extract/plugins/tables.py
extract
def extract(self, content, output): """Try to extract tables from an invoice""" for table in self['tables']: # First apply default options. plugin_settings = DEFAULT_OPTIONS.copy() plugin_settings.update(table) table = plugin_settings # Validate settings assert...
python
def extract(self, content, output): """Try to extract tables from an invoice""" for table in self['tables']: # First apply default options. plugin_settings = DEFAULT_OPTIONS.copy() plugin_settings.update(table) table = plugin_settings # Validate settings assert...
[ "def", "extract", "(", "self", ",", "content", ",", "output", ")", ":", "for", "table", "in", "self", "[", "'tables'", "]", ":", "# First apply default options.", "plugin_settings", "=", "DEFAULT_OPTIONS", ".", "copy", "(", ")", "plugin_settings", ".", "update...
Try to extract tables from an invoice
[ "Try", "to", "extract", "tables", "from", "an", "invoice" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/extract/plugins/tables.py#L11-L56
train
invoice-x/invoice2data
src/invoice2data/input/pdftotext.py
to_text
def to_text(path): """Wrapper around Poppler pdftotext. Parameters ---------- path : str path of electronic invoice in PDF Returns ------- out : str returns extracted text from pdf Raises ------ EnvironmentError: If pdftotext library is not found ""...
python
def to_text(path): """Wrapper around Poppler pdftotext. Parameters ---------- path : str path of electronic invoice in PDF Returns ------- out : str returns extracted text from pdf Raises ------ EnvironmentError: If pdftotext library is not found ""...
[ "def", "to_text", "(", "path", ")", ":", "import", "subprocess", "from", "distutils", "import", "spawn", "# py2 compat", "if", "spawn", ".", "find_executable", "(", "\"pdftotext\"", ")", ":", "# shutil.which('pdftotext'):", "out", ",", "err", "=", "subprocess", ...
Wrapper around Poppler pdftotext. Parameters ---------- path : str path of electronic invoice in PDF Returns ------- out : str returns extracted text from pdf Raises ------ EnvironmentError: If pdftotext library is not found
[ "Wrapper", "around", "Poppler", "pdftotext", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/input/pdftotext.py#L2-L31
train
invoice-x/invoice2data
src/invoice2data/extract/invoice_template.py
InvoiceTemplate.prepare_input
def prepare_input(self, extracted_str): """ Input raw string and do transformations, as set in template file. """ # Remove withspace if self.options['remove_whitespace']: optimized_str = re.sub(' +', '', extracted_str) else: optimized_str = extrac...
python
def prepare_input(self, extracted_str): """ Input raw string and do transformations, as set in template file. """ # Remove withspace if self.options['remove_whitespace']: optimized_str = re.sub(' +', '', extracted_str) else: optimized_str = extrac...
[ "def", "prepare_input", "(", "self", ",", "extracted_str", ")", ":", "# Remove withspace", "if", "self", ".", "options", "[", "'remove_whitespace'", "]", ":", "optimized_str", "=", "re", ".", "sub", "(", "' +'", ",", "''", ",", "extracted_str", ")", "else", ...
Input raw string and do transformations, as set in template file.
[ "Input", "raw", "string", "and", "do", "transformations", "as", "set", "in", "template", "file", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/extract/invoice_template.py#L64-L88
train
invoice-x/invoice2data
src/invoice2data/extract/invoice_template.py
InvoiceTemplate.matches_input
def matches_input(self, optimized_str): """See if string matches keywords set in template file""" if all([keyword in optimized_str for keyword in self['keywords']]): logger.debug('Matched template %s', self['template_name']) return True
python
def matches_input(self, optimized_str): """See if string matches keywords set in template file""" if all([keyword in optimized_str for keyword in self['keywords']]): logger.debug('Matched template %s', self['template_name']) return True
[ "def", "matches_input", "(", "self", ",", "optimized_str", ")", ":", "if", "all", "(", "[", "keyword", "in", "optimized_str", "for", "keyword", "in", "self", "[", "'keywords'", "]", "]", ")", ":", "logger", ".", "debug", "(", "'Matched template %s'", ",", ...
See if string matches keywords set in template file
[ "See", "if", "string", "matches", "keywords", "set", "in", "template", "file" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/extract/invoice_template.py#L90-L95
train
invoice-x/invoice2data
src/invoice2data/extract/invoice_template.py
InvoiceTemplate.parse_date
def parse_date(self, value): """Parses date and returns date after parsing""" res = dateparser.parse( value, date_formats=self.options['date_formats'], languages=self.options['languages'] ) logger.debug("result of date parsing=%s", res) return res
python
def parse_date(self, value): """Parses date and returns date after parsing""" res = dateparser.parse( value, date_formats=self.options['date_formats'], languages=self.options['languages'] ) logger.debug("result of date parsing=%s", res) return res
[ "def", "parse_date", "(", "self", ",", "value", ")", ":", "res", "=", "dateparser", ".", "parse", "(", "value", ",", "date_formats", "=", "self", ".", "options", "[", "'date_formats'", "]", ",", "languages", "=", "self", ".", "options", "[", "'languages'...
Parses date and returns date after parsing
[ "Parses", "date", "and", "returns", "date", "after", "parsing" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/extract/invoice_template.py#L108-L114
train
invoice-x/invoice2data
src/invoice2data/output/to_json.py
write_to_file
def write_to_file(data, path): """Export extracted fields to json Appends .json to path if missing and generates json file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated json fi...
python
def write_to_file(data, path): """Export extracted fields to json Appends .json to path if missing and generates json file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated json fi...
[ "def", "write_to_file", "(", "data", ",", "path", ")", ":", "if", "path", ".", "endswith", "(", "'.json'", ")", ":", "filename", "=", "path", "else", ":", "filename", "=", "path", "+", "'.json'", "with", "codecs", ".", "open", "(", "filename", ",", "...
Export extracted fields to json Appends .json to path if missing and generates json file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated json file Notes ---- Do give fil...
[ "Export", "extracted", "fields", "to", "json" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/output/to_json.py#L12-L47
train
invoice-x/invoice2data
src/invoice2data/main.py
create_parser
def create_parser(): """Returns argument parser """ parser = argparse.ArgumentParser( description='Extract structured data from PDF files and save to CSV or JSON.' ) parser.add_argument( '--input-reader', choices=input_mapping.keys(), default='pdftotext', help='...
python
def create_parser(): """Returns argument parser """ parser = argparse.ArgumentParser( description='Extract structured data from PDF files and save to CSV or JSON.' ) parser.add_argument( '--input-reader', choices=input_mapping.keys(), default='pdftotext', help='...
[ "def", "create_parser", "(", ")", ":", "parser", "=", "argparse", ".", "ArgumentParser", "(", "description", "=", "'Extract structured data from PDF files and save to CSV or JSON.'", ")", "parser", ".", "add_argument", "(", "'--input-reader'", ",", "choices", "=", "inpu...
Returns argument parser
[ "Returns", "argument", "parser" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/main.py#L99-L167
train
invoice-x/invoice2data
src/invoice2data/main.py
main
def main(args=None): """Take folder or single file and analyze each.""" if args is None: parser = create_parser() args = parser.parse_args() if args.debug: logging.basicConfig(level=logging.DEBUG) else: logging.basicConfig(level=logging.INFO) input_module = input_ma...
python
def main(args=None): """Take folder or single file and analyze each.""" if args is None: parser = create_parser() args = parser.parse_args() if args.debug: logging.basicConfig(level=logging.DEBUG) else: logging.basicConfig(level=logging.INFO) input_module = input_ma...
[ "def", "main", "(", "args", "=", "None", ")", ":", "if", "args", "is", "None", ":", "parser", "=", "create_parser", "(", ")", "args", "=", "parser", ".", "parse_args", "(", ")", "if", "args", ".", "debug", ":", "logging", ".", "basicConfig", "(", "...
Take folder or single file and analyze each.
[ "Take", "folder", "or", "single", "file", "and", "analyze", "each", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/main.py#L170-L215
train
invoice-x/invoice2data
src/invoice2data/output/to_xml.py
write_to_file
def write_to_file(data, path): """Export extracted fields to xml Appends .xml to path if missing and generates xml file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated xml file ...
python
def write_to_file(data, path): """Export extracted fields to xml Appends .xml to path if missing and generates xml file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated xml file ...
[ "def", "write_to_file", "(", "data", ",", "path", ")", ":", "if", "path", ".", "endswith", "(", "'.xml'", ")", ":", "filename", "=", "path", "else", ":", "filename", "=", "path", "+", "'.xml'", "tag_data", "=", "ET", ".", "Element", "(", "'data'", ")...
Export extracted fields to xml Appends .xml to path if missing and generates xml file in specified directory, if not then in root Parameters ---------- data : dict Dictionary of extracted fields path : str directory to save generated xml file Notes ---- Do give file na...
[ "Export", "extracted", "fields", "to", "xml" ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/output/to_xml.py#L12-L59
train
invoice-x/invoice2data
src/invoice2data/extract/loader.py
read_templates
def read_templates(folder=None): """ Load yaml templates from template folder. Return list of dicts. Use built-in templates if no folder is set. Parameters ---------- folder : str user defined folder where they stores their files, if None uses built-in templates Returns ------...
python
def read_templates(folder=None): """ Load yaml templates from template folder. Return list of dicts. Use built-in templates if no folder is set. Parameters ---------- folder : str user defined folder where they stores their files, if None uses built-in templates Returns ------...
[ "def", "read_templates", "(", "folder", "=", "None", ")", ":", "output", "=", "[", "]", "if", "folder", "is", "None", ":", "folder", "=", "pkg_resources", ".", "resource_filename", "(", "__name__", ",", "'templates'", ")", "for", "path", ",", "subdirs", ...
Load yaml templates from template folder. Return list of dicts. Use built-in templates if no folder is set. Parameters ---------- folder : str user defined folder where they stores their files, if None uses built-in templates Returns ------- output : Instance of `InvoiceTemplate` ...
[ "Load", "yaml", "templates", "from", "template", "folder", ".", "Return", "list", "of", "dicts", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/extract/loader.py#L39-L99
train
invoice-x/invoice2data
src/invoice2data/input/pdfminer_wrapper.py
to_text
def to_text(path): """Wrapper around `pdfminer`. Parameters ---------- path : str path of electronic invoice in PDF Returns ------- str : str returns extracted text from pdf """ try: # python 2 from StringIO import StringIO import sys ...
python
def to_text(path): """Wrapper around `pdfminer`. Parameters ---------- path : str path of electronic invoice in PDF Returns ------- str : str returns extracted text from pdf """ try: # python 2 from StringIO import StringIO import sys ...
[ "def", "to_text", "(", "path", ")", ":", "try", ":", "# python 2", "from", "StringIO", "import", "StringIO", "import", "sys", "reload", "(", "sys", ")", "# noqa: F821", "sys", ".", "setdefaultencoding", "(", "'utf8'", ")", "except", "ImportError", ":", "from...
Wrapper around `pdfminer`. Parameters ---------- path : str path of electronic invoice in PDF Returns ------- str : str returns extracted text from pdf
[ "Wrapper", "around", "pdfminer", "." ]
d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20
https://github.com/invoice-x/invoice2data/blob/d97fdc5db9c1844fd77fa64f8ea7c42fefd0ba20/src/invoice2data/input/pdfminer_wrapper.py#L2-L57
train
SALib/SALib
src/SALib/analyze/ff.py
analyze
def analyze(problem, X, Y, second_order=False, print_to_console=False, seed=None): """Perform a fractional factorial analysis Returns a dictionary with keys 'ME' (main effect) and 'IE' (interaction effect). The techniques bulks out the number of parameters with dummy parameters to the neare...
python
def analyze(problem, X, Y, second_order=False, print_to_console=False, seed=None): """Perform a fractional factorial analysis Returns a dictionary with keys 'ME' (main effect) and 'IE' (interaction effect). The techniques bulks out the number of parameters with dummy parameters to the neare...
[ "def", "analyze", "(", "problem", ",", "X", ",", "Y", ",", "second_order", "=", "False", ",", "print_to_console", "=", "False", ",", "seed", "=", "None", ")", ":", "if", "seed", ":", "np", ".", "random", ".", "seed", "(", "seed", ")", "problem", "=...
Perform a fractional factorial analysis Returns a dictionary with keys 'ME' (main effect) and 'IE' (interaction effect). The techniques bulks out the number of parameters with dummy parameters to the nearest 2**n. Any results involving dummy parameters could indicate a problem with the model runs. ...
[ "Perform", "a", "fractional", "factorial", "analysis" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/analyze/ff.py#L18-L81
train
SALib/SALib
src/SALib/analyze/ff.py
to_df
def to_df(self): '''Conversion method to Pandas DataFrame. To be attached to ResultDict. Returns ------- main_effect, inter_effect: tuple A tuple of DataFrames for main effects and interaction effects. The second element (for interactions) will be `None` if not available. ''' na...
python
def to_df(self): '''Conversion method to Pandas DataFrame. To be attached to ResultDict. Returns ------- main_effect, inter_effect: tuple A tuple of DataFrames for main effects and interaction effects. The second element (for interactions) will be `None` if not available. ''' na...
[ "def", "to_df", "(", "self", ")", ":", "names", "=", "self", "[", "'names'", "]", "main_effect", "=", "self", "[", "'ME'", "]", "interactions", "=", "self", ".", "get", "(", "'IE'", ",", "None", ")", "inter_effect", "=", "None", "if", "interactions", ...
Conversion method to Pandas DataFrame. To be attached to ResultDict. Returns ------- main_effect, inter_effect: tuple A tuple of DataFrames for main effects and interaction effects. The second element (for interactions) will be `None` if not available.
[ "Conversion", "method", "to", "Pandas", "DataFrame", ".", "To", "be", "attached", "to", "ResultDict", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/analyze/ff.py#L84-L106
train
SALib/SALib
src/SALib/analyze/ff.py
interactions
def interactions(problem, Y, print_to_console=False): """Computes the second order effects Computes the second order effects (interactions) between all combinations of pairs of input factors Arguments --------- problem: dict The problem definition Y: numpy.array The NumPy a...
python
def interactions(problem, Y, print_to_console=False): """Computes the second order effects Computes the second order effects (interactions) between all combinations of pairs of input factors Arguments --------- problem: dict The problem definition Y: numpy.array The NumPy a...
[ "def", "interactions", "(", "problem", ",", "Y", ",", "print_to_console", "=", "False", ")", ":", "names", "=", "problem", "[", "'names'", "]", "num_vars", "=", "problem", "[", "'num_vars'", "]", "X", "=", "generate_contrast", "(", "problem", ")", "ie_name...
Computes the second order effects Computes the second order effects (interactions) between all combinations of pairs of input factors Arguments --------- problem: dict The problem definition Y: numpy.array The NumPy array containing the model outputs print_to_console: bool,...
[ "Computes", "the", "second", "order", "effects" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/analyze/ff.py#L109-L150
train
SALib/SALib
src/SALib/util/__init__.py
avail_approaches
def avail_approaches(pkg): '''Create list of available modules. Arguments --------- pkg : module module to inspect Returns --------- method : list A list of available submodules ''' methods = [modname for importer, modname, ispkg in pkgutil.walk_packa...
python
def avail_approaches(pkg): '''Create list of available modules. Arguments --------- pkg : module module to inspect Returns --------- method : list A list of available submodules ''' methods = [modname for importer, modname, ispkg in pkgutil.walk_packa...
[ "def", "avail_approaches", "(", "pkg", ")", ":", "methods", "=", "[", "modname", "for", "importer", ",", "modname", ",", "ispkg", "in", "pkgutil", ".", "walk_packages", "(", "path", "=", "pkg", ".", "__path__", ")", "if", "modname", "not", "in", "[", "...
Create list of available modules. Arguments --------- pkg : module module to inspect Returns --------- method : list A list of available submodules
[ "Create", "list", "of", "available", "modules", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/__init__.py#L18-L35
train
SALib/SALib
src/SALib/util/__init__.py
scale_samples
def scale_samples(params, bounds): '''Rescale samples in 0-to-1 range to arbitrary bounds Arguments --------- bounds : list list of lists of dimensions `num_params`-by-2 params : numpy.ndarray numpy array of dimensions `num_params`-by-:math:`N`, where :math:`N` is the number...
python
def scale_samples(params, bounds): '''Rescale samples in 0-to-1 range to arbitrary bounds Arguments --------- bounds : list list of lists of dimensions `num_params`-by-2 params : numpy.ndarray numpy array of dimensions `num_params`-by-:math:`N`, where :math:`N` is the number...
[ "def", "scale_samples", "(", "params", ",", "bounds", ")", ":", "# Check bounds are legal (upper bound is greater than lower bound)", "b", "=", "np", ".", "array", "(", "bounds", ")", "lower_bounds", "=", "b", "[", ":", ",", "0", "]", "upper_bounds", "=", "b", ...
Rescale samples in 0-to-1 range to arbitrary bounds Arguments --------- bounds : list list of lists of dimensions `num_params`-by-2 params : numpy.ndarray numpy array of dimensions `num_params`-by-:math:`N`, where :math:`N` is the number of samples
[ "Rescale", "samples", "in", "0", "-", "to", "-", "1", "range", "to", "arbitrary", "bounds" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/__init__.py#L38-L65
train
SALib/SALib
src/SALib/util/__init__.py
nonuniform_scale_samples
def nonuniform_scale_samples(params, bounds, dists): """Rescale samples in 0-to-1 range to other distributions Arguments --------- problem : dict problem definition including bounds params : numpy.ndarray numpy array of dimensions num_params-by-N, where N is the number of sa...
python
def nonuniform_scale_samples(params, bounds, dists): """Rescale samples in 0-to-1 range to other distributions Arguments --------- problem : dict problem definition including bounds params : numpy.ndarray numpy array of dimensions num_params-by-N, where N is the number of sa...
[ "def", "nonuniform_scale_samples", "(", "params", ",", "bounds", ",", "dists", ")", ":", "b", "=", "np", ".", "array", "(", "bounds", ")", "# initializing matrix for converted values", "conv_params", "=", "np", ".", "zeros_like", "(", "params", ")", "# loop over...
Rescale samples in 0-to-1 range to other distributions Arguments --------- problem : dict problem definition including bounds params : numpy.ndarray numpy array of dimensions num_params-by-N, where N is the number of samples dists : list list of distributions, one fo...
[ "Rescale", "samples", "in", "0", "-", "to", "-", "1", "range", "to", "other", "distributions" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/__init__.py#L96-L165
train
SALib/SALib
src/SALib/util/__init__.py
read_param_file
def read_param_file(filename, delimiter=None): """Unpacks a parameter file into a dictionary Reads a parameter file of format:: Param1,0,1,Group1,dist1 Param2,0,1,Group2,dist2 Param3,0,1,Group3,dist3 (Group and Dist columns are optional) Returns a dictionary containing: ...
python
def read_param_file(filename, delimiter=None): """Unpacks a parameter file into a dictionary Reads a parameter file of format:: Param1,0,1,Group1,dist1 Param2,0,1,Group2,dist2 Param3,0,1,Group3,dist3 (Group and Dist columns are optional) Returns a dictionary containing: ...
[ "def", "read_param_file", "(", "filename", ",", "delimiter", "=", "None", ")", ":", "names", "=", "[", "]", "bounds", "=", "[", "]", "groups", "=", "[", "]", "dists", "=", "[", "]", "num_vars", "=", "0", "fieldnames", "=", "[", "'name'", ",", "'low...
Unpacks a parameter file into a dictionary Reads a parameter file of format:: Param1,0,1,Group1,dist1 Param2,0,1,Group2,dist2 Param3,0,1,Group3,dist3 (Group and Dist columns are optional) Returns a dictionary containing: - names - the names of the parameters - bou...
[ "Unpacks", "a", "parameter", "file", "into", "a", "dictionary" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/__init__.py#L168-L245
train
SALib/SALib
src/SALib/util/__init__.py
compute_groups_matrix
def compute_groups_matrix(groups): """Generate matrix which notes factor membership of groups Computes a k-by-g matrix which notes factor membership of groups where: k is the number of variables (factors) g is the number of groups Also returns a g-length list of unique group_names whose...
python
def compute_groups_matrix(groups): """Generate matrix which notes factor membership of groups Computes a k-by-g matrix which notes factor membership of groups where: k is the number of variables (factors) g is the number of groups Also returns a g-length list of unique group_names whose...
[ "def", "compute_groups_matrix", "(", "groups", ")", ":", "if", "not", "groups", ":", "return", "None", "num_vars", "=", "len", "(", "groups", ")", "# Get a unique set of the group names", "unique_group_names", "=", "list", "(", "OrderedDict", ".", "fromkeys", "(",...
Generate matrix which notes factor membership of groups Computes a k-by-g matrix which notes factor membership of groups where: k is the number of variables (factors) g is the number of groups Also returns a g-length list of unique group_names whose positions correspond to the order of ...
[ "Generate", "matrix", "which", "notes", "factor", "membership", "of", "groups" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/__init__.py#L248-L286
train
SALib/SALib
src/SALib/util/__init__.py
requires_gurobipy
def requires_gurobipy(_has_gurobi): ''' Decorator function which takes a boolean _has_gurobi as an argument. Use decorate any functions which require gurobi. Raises an import error at runtime if gurobi is not present. Note that all runtime errors should be avoided in the working code, using brut...
python
def requires_gurobipy(_has_gurobi): ''' Decorator function which takes a boolean _has_gurobi as an argument. Use decorate any functions which require gurobi. Raises an import error at runtime if gurobi is not present. Note that all runtime errors should be avoided in the working code, using brut...
[ "def", "requires_gurobipy", "(", "_has_gurobi", ")", ":", "def", "_outer_wrapper", "(", "wrapped_function", ")", ":", "def", "_wrapper", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "_has_gurobi", ":", "result", "=", "wrapped_function", "(", ...
Decorator function which takes a boolean _has_gurobi as an argument. Use decorate any functions which require gurobi. Raises an import error at runtime if gurobi is not present. Note that all runtime errors should be avoided in the working code, using brute force options as preference.
[ "Decorator", "function", "which", "takes", "a", "boolean", "_has_gurobi", "as", "an", "argument", ".", "Use", "decorate", "any", "functions", "which", "require", "gurobi", ".", "Raises", "an", "import", "error", "at", "runtime", "if", "gurobi", "is", "not", ...
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/__init__.py#L289-L306
train
SALib/SALib
src/SALib/analyze/morris.py
compute_grouped_sigma
def compute_grouped_sigma(ungrouped_sigma, group_matrix): ''' Returns sigma for the groups of parameter values in the argument ungrouped_metric where the group consists of no more than one parameter ''' group_matrix = np.array(group_matrix, dtype=np.bool) sigma_masked = np.ma.masked_array(...
python
def compute_grouped_sigma(ungrouped_sigma, group_matrix): ''' Returns sigma for the groups of parameter values in the argument ungrouped_metric where the group consists of no more than one parameter ''' group_matrix = np.array(group_matrix, dtype=np.bool) sigma_masked = np.ma.masked_array(...
[ "def", "compute_grouped_sigma", "(", "ungrouped_sigma", ",", "group_matrix", ")", ":", "group_matrix", "=", "np", ".", "array", "(", "group_matrix", ",", "dtype", "=", "np", ".", "bool", ")", "sigma_masked", "=", "np", ".", "ma", ".", "masked_array", "(", ...
Returns sigma for the groups of parameter values in the argument ungrouped_metric where the group consists of no more than one parameter
[ "Returns", "sigma", "for", "the", "groups", "of", "parameter", "values", "in", "the", "argument", "ungrouped_metric", "where", "the", "group", "consists", "of", "no", "more", "than", "one", "parameter" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/analyze/morris.py#L170-L186
train
SALib/SALib
src/SALib/analyze/morris.py
compute_grouped_metric
def compute_grouped_metric(ungrouped_metric, group_matrix): ''' Computes the mean value for the groups of parameter values in the argument ungrouped_metric ''' group_matrix = np.array(group_matrix, dtype=np.bool) mu_star_masked = np.ma.masked_array(ungrouped_metric * group_matrix.T, ...
python
def compute_grouped_metric(ungrouped_metric, group_matrix): ''' Computes the mean value for the groups of parameter values in the argument ungrouped_metric ''' group_matrix = np.array(group_matrix, dtype=np.bool) mu_star_masked = np.ma.masked_array(ungrouped_metric * group_matrix.T, ...
[ "def", "compute_grouped_metric", "(", "ungrouped_metric", ",", "group_matrix", ")", ":", "group_matrix", "=", "np", ".", "array", "(", "group_matrix", ",", "dtype", "=", "np", ".", "bool", ")", "mu_star_masked", "=", "np", ".", "ma", ".", "masked_array", "("...
Computes the mean value for the groups of parameter values in the argument ungrouped_metric
[ "Computes", "the", "mean", "value", "for", "the", "groups", "of", "parameter", "values", "in", "the", "argument", "ungrouped_metric" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/analyze/morris.py#L189-L201
train
SALib/SALib
src/SALib/analyze/morris.py
compute_mu_star_confidence
def compute_mu_star_confidence(ee, num_trajectories, num_resamples, conf_level): ''' Uses bootstrapping where the elementary effects are resampled with replacement to produce a histogram of resampled mu_star metrics. This resample is used to produce a confidence interval. ...
python
def compute_mu_star_confidence(ee, num_trajectories, num_resamples, conf_level): ''' Uses bootstrapping where the elementary effects are resampled with replacement to produce a histogram of resampled mu_star metrics. This resample is used to produce a confidence interval. ...
[ "def", "compute_mu_star_confidence", "(", "ee", ",", "num_trajectories", ",", "num_resamples", ",", "conf_level", ")", ":", "ee_resampled", "=", "np", ".", "zeros", "(", "[", "num_trajectories", "]", ")", "mu_star_resampled", "=", "np", ".", "zeros", "(", "[",...
Uses bootstrapping where the elementary effects are resampled with replacement to produce a histogram of resampled mu_star metrics. This resample is used to produce a confidence interval.
[ "Uses", "bootstrapping", "where", "the", "elementary", "effects", "are", "resampled", "with", "replacement", "to", "produce", "a", "histogram", "of", "resampled", "mu_star", "metrics", ".", "This", "resample", "is", "used", "to", "produce", "a", "confidence", "i...
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/analyze/morris.py#L261-L280
train
SALib/SALib
src/SALib/sample/morris/gurobi.py
timestamp
def timestamp(num_params, p_levels, k_choices, N): """ Returns a uniform timestamp with parameter values for file identification """ string = "_v%s_l%s_gs%s_k%s_N%s_%s.txt" % (num_params, p_levels, k_choices, ...
python
def timestamp(num_params, p_levels, k_choices, N): """ Returns a uniform timestamp with parameter values for file identification """ string = "_v%s_l%s_gs%s_k%s_N%s_%s.txt" % (num_params, p_levels, k_choices, ...
[ "def", "timestamp", "(", "num_params", ",", "p_levels", ",", "k_choices", ",", "N", ")", ":", "string", "=", "\"_v%s_l%s_gs%s_k%s_N%s_%s.txt\"", "%", "(", "num_params", ",", "p_levels", ",", "k_choices", ",", "N", ",", "dt", ".", "strftime", "(", "dt", "."...
Returns a uniform timestamp with parameter values for file identification
[ "Returns", "a", "uniform", "timestamp", "with", "parameter", "values", "for", "file", "identification" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/gurobi.py#L131-L141
train
SALib/SALib
src/SALib/sample/morris/brute.py
BruteForce.brute_force_most_distant
def brute_force_most_distant(self, input_sample, num_samples, num_params, k_choices, num_groups=None): """Use brute force method to find most distant trajectories Arguments --------- input_sample : numpy.ndarray n...
python
def brute_force_most_distant(self, input_sample, num_samples, num_params, k_choices, num_groups=None): """Use brute force method to find most distant trajectories Arguments --------- input_sample : numpy.ndarray n...
[ "def", "brute_force_most_distant", "(", "self", ",", "input_sample", ",", "num_samples", ",", "num_params", ",", "k_choices", ",", "num_groups", "=", "None", ")", ":", "scores", "=", "self", ".", "find_most_distant", "(", "input_sample", ",", "num_samples", ",",...
Use brute force method to find most distant trajectories Arguments --------- input_sample : numpy.ndarray num_samples : int The number of samples to generate num_params : int The number of parameters k_choices : int The number of optim...
[ "Use", "brute", "force", "method", "to", "find", "most", "distant", "trajectories" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/brute.py#L19-L48
train
SALib/SALib
src/SALib/sample/morris/brute.py
BruteForce.find_most_distant
def find_most_distant(self, input_sample, num_samples, num_params, k_choices, num_groups=None): """ Finds the 'k_choices' most distant choices from the 'num_samples' trajectories contained in 'input_sample' Arguments --------- input_sample : num...
python
def find_most_distant(self, input_sample, num_samples, num_params, k_choices, num_groups=None): """ Finds the 'k_choices' most distant choices from the 'num_samples' trajectories contained in 'input_sample' Arguments --------- input_sample : num...
[ "def", "find_most_distant", "(", "self", ",", "input_sample", ",", "num_samples", ",", "num_params", ",", "k_choices", ",", "num_groups", "=", "None", ")", ":", "# Now evaluate the (N choose k_choices) possible combinations", "if", "nchoosek", "(", "num_samples", ",", ...
Finds the 'k_choices' most distant choices from the 'num_samples' trajectories contained in 'input_sample' Arguments --------- input_sample : numpy.ndarray num_samples : int The number of samples to generate num_params : int The number of paramete...
[ "Finds", "the", "k_choices", "most", "distant", "choices", "from", "the", "num_samples", "trajectories", "contained", "in", "input_sample" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/brute.py#L50-L101
train
SALib/SALib
src/SALib/sample/morris/brute.py
BruteForce.mappable
def mappable(combos, pairwise, distance_matrix): ''' Obtains scores from the distance_matrix for each pairwise combination held in the combos array Arguments ---------- combos : numpy.ndarray pairwise : numpy.ndarray distance_matrix : numpy.ndarray ...
python
def mappable(combos, pairwise, distance_matrix): ''' Obtains scores from the distance_matrix for each pairwise combination held in the combos array Arguments ---------- combos : numpy.ndarray pairwise : numpy.ndarray distance_matrix : numpy.ndarray ...
[ "def", "mappable", "(", "combos", ",", "pairwise", ",", "distance_matrix", ")", ":", "combos", "=", "np", ".", "array", "(", "combos", ")", "# Create a list of all pairwise combination for each combo in combos", "combo_list", "=", "combos", "[", ":", ",", "pairwise"...
Obtains scores from the distance_matrix for each pairwise combination held in the combos array Arguments ---------- combos : numpy.ndarray pairwise : numpy.ndarray distance_matrix : numpy.ndarray
[ "Obtains", "scores", "from", "the", "distance_matrix", "for", "each", "pairwise", "combination", "held", "in", "the", "combos", "array" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/brute.py#L113-L133
train
SALib/SALib
src/SALib/sample/morris/brute.py
BruteForce.find_maximum
def find_maximum(self, scores, N, k_choices): """Finds the `k_choices` maximum scores from `scores` Arguments --------- scores : numpy.ndarray N : int k_choices : int Returns ------- list """ if not isinstance(scores, np.ndarray):...
python
def find_maximum(self, scores, N, k_choices): """Finds the `k_choices` maximum scores from `scores` Arguments --------- scores : numpy.ndarray N : int k_choices : int Returns ------- list """ if not isinstance(scores, np.ndarray):...
[ "def", "find_maximum", "(", "self", ",", "scores", ",", "N", ",", "k_choices", ")", ":", "if", "not", "isinstance", "(", "scores", ",", "np", ".", "ndarray", ")", ":", "raise", "TypeError", "(", "\"Scores input is not a numpy array\"", ")", "index_of_maximum",...
Finds the `k_choices` maximum scores from `scores` Arguments --------- scores : numpy.ndarray N : int k_choices : int Returns ------- list
[ "Finds", "the", "k_choices", "maximum", "scores", "from", "scores" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/brute.py#L135-L154
train
SALib/SALib
src/SALib/sample/morris/brute.py
BruteForce.nth
def nth(iterable, n, default=None): """Returns the nth item or a default value Arguments --------- iterable : iterable n : int default : default=None The default value to return """ if type(n) != int: raise TypeError("n is not an ...
python
def nth(iterable, n, default=None): """Returns the nth item or a default value Arguments --------- iterable : iterable n : int default : default=None The default value to return """ if type(n) != int: raise TypeError("n is not an ...
[ "def", "nth", "(", "iterable", ",", "n", ",", "default", "=", "None", ")", ":", "if", "type", "(", "n", ")", "!=", "int", ":", "raise", "TypeError", "(", "\"n is not an integer\"", ")", "return", "next", "(", "islice", "(", "iterable", ",", "n", ",",...
Returns the nth item or a default value Arguments --------- iterable : iterable n : int default : default=None The default value to return
[ "Returns", "the", "nth", "item", "or", "a", "default", "value" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/brute.py#L157-L171
train
SALib/SALib
src/SALib/sample/morris/__init__.py
sample
def sample(problem, N, num_levels=4, optimal_trajectories=None, local_optimization=True): """Generate model inputs using the Method of Morris Returns a NumPy matrix containing the model inputs required for Method of Morris. The resulting matrix has :math:`(G+1)*T` rows and :math:`D` columns...
python
def sample(problem, N, num_levels=4, optimal_trajectories=None, local_optimization=True): """Generate model inputs using the Method of Morris Returns a NumPy matrix containing the model inputs required for Method of Morris. The resulting matrix has :math:`(G+1)*T` rows and :math:`D` columns...
[ "def", "sample", "(", "problem", ",", "N", ",", "num_levels", "=", "4", ",", "optimal_trajectories", "=", "None", ",", "local_optimization", "=", "True", ")", ":", "if", "problem", ".", "get", "(", "'groups'", ")", ":", "sample", "=", "_sample_groups", "...
Generate model inputs using the Method of Morris Returns a NumPy matrix containing the model inputs required for Method of Morris. The resulting matrix has :math:`(G+1)*T` rows and :math:`D` columns, where :math:`D` is the number of parameters, :math:`G` is the number of groups (if no groups are selec...
[ "Generate", "model", "inputs", "using", "the", "Method", "of", "Morris" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/__init__.py#L53-L103
train
SALib/SALib
src/SALib/sample/morris/__init__.py
_sample_oat
def _sample_oat(problem, N, num_levels=4): """Generate trajectories without groups Arguments --------- problem : dict The problem definition N : int The number of samples to generate num_levels : int, default=4 The number of grid levels """ group_membership = np....
python
def _sample_oat(problem, N, num_levels=4): """Generate trajectories without groups Arguments --------- problem : dict The problem definition N : int The number of samples to generate num_levels : int, default=4 The number of grid levels """ group_membership = np....
[ "def", "_sample_oat", "(", "problem", ",", "N", ",", "num_levels", "=", "4", ")", ":", "group_membership", "=", "np", ".", "asmatrix", "(", "np", ".", "identity", "(", "problem", "[", "'num_vars'", "]", ",", "dtype", "=", "int", ")", ")", "num_params",...
Generate trajectories without groups Arguments --------- problem : dict The problem definition N : int The number of samples to generate num_levels : int, default=4 The number of grid levels
[ "Generate", "trajectories", "without", "groups" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/__init__.py#L106-L126
train
SALib/SALib
src/SALib/sample/morris/__init__.py
_sample_groups
def _sample_groups(problem, N, num_levels=4): """Generate trajectories for groups Returns an :math:`N(g+1)`-by-:math:`k` array of `N` trajectories, where :math:`g` is the number of groups and :math:`k` is the number of factors Arguments --------- problem : dict The problem definiti...
python
def _sample_groups(problem, N, num_levels=4): """Generate trajectories for groups Returns an :math:`N(g+1)`-by-:math:`k` array of `N` trajectories, where :math:`g` is the number of groups and :math:`k` is the number of factors Arguments --------- problem : dict The problem definiti...
[ "def", "_sample_groups", "(", "problem", ",", "N", ",", "num_levels", "=", "4", ")", ":", "if", "len", "(", "problem", "[", "'groups'", "]", ")", "!=", "problem", "[", "'num_vars'", "]", ":", "raise", "ValueError", "(", "\"Groups do not match to number of va...
Generate trajectories for groups Returns an :math:`N(g+1)`-by-:math:`k` array of `N` trajectories, where :math:`g` is the number of groups and :math:`k` is the number of factors Arguments --------- problem : dict The problem definition N : int The number of trajectories to ...
[ "Generate", "trajectories", "for", "groups" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/__init__.py#L129-L166
train
SALib/SALib
src/SALib/sample/morris/__init__.py
generate_trajectory
def generate_trajectory(group_membership, num_levels=4): """Return a single trajectory Return a single trajectory of size :math:`(g+1)`-by-:math:`k` where :math:`g` is the number of groups, and :math:`k` is the number of factors, both implied by the dimensions of `group_membership` Arguments ...
python
def generate_trajectory(group_membership, num_levels=4): """Return a single trajectory Return a single trajectory of size :math:`(g+1)`-by-:math:`k` where :math:`g` is the number of groups, and :math:`k` is the number of factors, both implied by the dimensions of `group_membership` Arguments ...
[ "def", "generate_trajectory", "(", "group_membership", ",", "num_levels", "=", "4", ")", ":", "delta", "=", "compute_delta", "(", "num_levels", ")", "# Infer number of groups `g` and number of params `k` from", "# `group_membership` matrix", "num_params", "=", "group_membersh...
Return a single trajectory Return a single trajectory of size :math:`(g+1)`-by-:math:`k` where :math:`g` is the number of groups, and :math:`k` is the number of factors, both implied by the dimensions of `group_membership` Arguments --------- group_membership : np.ndarray a k-by-g ...
[ "Return", "a", "single", "trajectory" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/__init__.py#L169-L215
train
SALib/SALib
src/SALib/sample/morris/__init__.py
generate_p_star
def generate_p_star(num_groups): """Describe the order in which groups move Arguments --------- num_groups : int Returns ------- np.ndarray Matrix P* - size (g-by-g) """ p_star = np.eye(num_groups, num_groups) rd.shuffle(p_star) return p_star
python
def generate_p_star(num_groups): """Describe the order in which groups move Arguments --------- num_groups : int Returns ------- np.ndarray Matrix P* - size (g-by-g) """ p_star = np.eye(num_groups, num_groups) rd.shuffle(p_star) return p_star
[ "def", "generate_p_star", "(", "num_groups", ")", ":", "p_star", "=", "np", ".", "eye", "(", "num_groups", ",", "num_groups", ")", "rd", ".", "shuffle", "(", "p_star", ")", "return", "p_star" ]
Describe the order in which groups move Arguments --------- num_groups : int Returns ------- np.ndarray Matrix P* - size (g-by-g)
[ "Describe", "the", "order", "in", "which", "groups", "move" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/__init__.py#L230-L244
train
SALib/SALib
src/SALib/scripts/salib.py
parse_subargs
def parse_subargs(module, parser, method, opts): '''Attach argument parser for action specific options. Arguments --------- module : module name of module to extract action from parser : argparser argparser object to attach additional arguments to method : str name of me...
python
def parse_subargs(module, parser, method, opts): '''Attach argument parser for action specific options. Arguments --------- module : module name of module to extract action from parser : argparser argparser object to attach additional arguments to method : str name of me...
[ "def", "parse_subargs", "(", "module", ",", "parser", ",", "method", ",", "opts", ")", ":", "module", ".", "cli_args", "(", "parser", ")", "subargs", "=", "parser", ".", "parse_args", "(", "opts", ")", "return", "subargs" ]
Attach argument parser for action specific options. Arguments --------- module : module name of module to extract action from parser : argparser argparser object to attach additional arguments to method : str name of method (morris, sobol, etc). Must match one of the...
[ "Attach", "argument", "parser", "for", "action", "specific", "options", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/scripts/salib.py#L8-L29
train
SALib/SALib
src/SALib/sample/morris/local.py
LocalOptimisation.find_local_maximum
def find_local_maximum(self, input_sample, N, num_params, k_choices, num_groups=None): """Find the most different trajectories in the input sample using a local approach An alternative by Ruano et al. (2012) for the brute force approach as originally proposed ...
python
def find_local_maximum(self, input_sample, N, num_params, k_choices, num_groups=None): """Find the most different trajectories in the input sample using a local approach An alternative by Ruano et al. (2012) for the brute force approach as originally proposed ...
[ "def", "find_local_maximum", "(", "self", ",", "input_sample", ",", "N", ",", "num_params", ",", "k_choices", ",", "num_groups", "=", "None", ")", ":", "distance_matrix", "=", "self", ".", "compute_distance_matrix", "(", "input_sample", ",", "N", ",", "num_par...
Find the most different trajectories in the input sample using a local approach An alternative by Ruano et al. (2012) for the brute force approach as originally proposed by Campolongo et al. (2007). The method should improve the speed with which an optimal set of trajectories is ...
[ "Find", "the", "most", "different", "trajectories", "in", "the", "input", "sample", "using", "a", "local", "approach" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/local.py#L18-L89
train
SALib/SALib
src/SALib/sample/morris/local.py
LocalOptimisation.sum_distances
def sum_distances(self, indices, distance_matrix): """Calculate combinatorial distance between a select group of trajectories, indicated by indices Arguments --------- indices : tuple distance_matrix : numpy.ndarray (M,M) Returns ------- numpy.nd...
python
def sum_distances(self, indices, distance_matrix): """Calculate combinatorial distance between a select group of trajectories, indicated by indices Arguments --------- indices : tuple distance_matrix : numpy.ndarray (M,M) Returns ------- numpy.nd...
[ "def", "sum_distances", "(", "self", ",", "indices", ",", "distance_matrix", ")", ":", "combs_tup", "=", "np", ".", "array", "(", "tuple", "(", "combinations", "(", "indices", ",", "2", ")", ")", ")", "# Put indices from tuples into two-dimensional array.", "com...
Calculate combinatorial distance between a select group of trajectories, indicated by indices Arguments --------- indices : tuple distance_matrix : numpy.ndarray (M,M) Returns ------- numpy.ndarray Notes ----- This function can p...
[ "Calculate", "combinatorial", "distance", "between", "a", "select", "group", "of", "trajectories", "indicated", "by", "indices" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/local.py#L91-L121
train
SALib/SALib
src/SALib/sample/morris/local.py
LocalOptimisation.get_max_sum_ind
def get_max_sum_ind(self, indices_list, distances, i, m): '''Get the indices that belong to the maximum distance in `distances` Arguments --------- indices_list : list list of tuples distances : numpy.ndarray size M i : int m : int ...
python
def get_max_sum_ind(self, indices_list, distances, i, m): '''Get the indices that belong to the maximum distance in `distances` Arguments --------- indices_list : list list of tuples distances : numpy.ndarray size M i : int m : int ...
[ "def", "get_max_sum_ind", "(", "self", ",", "indices_list", ",", "distances", ",", "i", ",", "m", ")", ":", "if", "len", "(", "indices_list", ")", "!=", "len", "(", "distances", ")", ":", "msg", "=", "\"Indices and distances are lists of different length.\"", ...
Get the indices that belong to the maximum distance in `distances` Arguments --------- indices_list : list list of tuples distances : numpy.ndarray size M i : int m : int Returns ------- list
[ "Get", "the", "indices", "that", "belong", "to", "the", "maximum", "distance", "in", "distances" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/local.py#L123-L147
train
SALib/SALib
src/SALib/sample/morris/local.py
LocalOptimisation.add_indices
def add_indices(self, indices, distance_matrix): '''Adds extra indices for the combinatorial problem. Arguments --------- indices : tuple distance_matrix : numpy.ndarray (M,M) Example ------- >>> add_indices((1,2), numpy.array((5,5))) [(1, 2, 3),...
python
def add_indices(self, indices, distance_matrix): '''Adds extra indices for the combinatorial problem. Arguments --------- indices : tuple distance_matrix : numpy.ndarray (M,M) Example ------- >>> add_indices((1,2), numpy.array((5,5))) [(1, 2, 3),...
[ "def", "add_indices", "(", "self", ",", "indices", ",", "distance_matrix", ")", ":", "list_new_indices", "=", "[", "]", "for", "i", "in", "range", "(", "0", ",", "len", "(", "distance_matrix", ")", ")", ":", "if", "i", "not", "in", "indices", ":", "l...
Adds extra indices for the combinatorial problem. Arguments --------- indices : tuple distance_matrix : numpy.ndarray (M,M) Example ------- >>> add_indices((1,2), numpy.array((5,5))) [(1, 2, 3), (1, 2, 4), (1, 2, 5)]
[ "Adds", "extra", "indices", "for", "the", "combinatorial", "problem", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/local.py#L149-L167
train
SALib/SALib
src/SALib/util/results.py
ResultDict.to_df
def to_df(self): '''Convert dict structure into Pandas DataFrame.''' return pd.DataFrame({k: v for k, v in self.items() if k is not 'names'}, index=self['names'])
python
def to_df(self): '''Convert dict structure into Pandas DataFrame.''' return pd.DataFrame({k: v for k, v in self.items() if k is not 'names'}, index=self['names'])
[ "def", "to_df", "(", "self", ")", ":", "return", "pd", ".", "DataFrame", "(", "{", "k", ":", "v", "for", "k", ",", "v", "in", "self", ".", "items", "(", ")", "if", "k", "is", "not", "'names'", "}", ",", "index", "=", "self", "[", "'names'", "...
Convert dict structure into Pandas DataFrame.
[ "Convert", "dict", "structure", "into", "Pandas", "DataFrame", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/util/results.py#L13-L16
train
SALib/SALib
src/SALib/plotting/morris.py
horizontal_bar_plot
def horizontal_bar_plot(ax, Si, param_dict, sortby='mu_star', unit=''): '''Updates a matplotlib axes instance with a horizontal bar plot of mu_star, with error bars representing mu_star_conf ''' assert sortby in ['mu_star', 'mu_star_conf', 'sigma', 'mu'] # Sort all the plotted elements by mu_star...
python
def horizontal_bar_plot(ax, Si, param_dict, sortby='mu_star', unit=''): '''Updates a matplotlib axes instance with a horizontal bar plot of mu_star, with error bars representing mu_star_conf ''' assert sortby in ['mu_star', 'mu_star_conf', 'sigma', 'mu'] # Sort all the plotted elements by mu_star...
[ "def", "horizontal_bar_plot", "(", "ax", ",", "Si", ",", "param_dict", ",", "sortby", "=", "'mu_star'", ",", "unit", "=", "''", ")", ":", "assert", "sortby", "in", "[", "'mu_star'", ",", "'mu_star_conf'", ",", "'sigma'", ",", "'mu'", "]", "# Sort all the p...
Updates a matplotlib axes instance with a horizontal bar plot of mu_star, with error bars representing mu_star_conf
[ "Updates", "a", "matplotlib", "axes", "instance", "with", "a", "horizontal", "bar", "plot" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/plotting/morris.py#L33-L64
train
SALib/SALib
src/SALib/plotting/morris.py
sample_histograms
def sample_histograms(fig, input_sample, problem, param_dict): '''Plots a set of subplots of histograms of the input sample ''' num_vars = problem['num_vars'] names = problem['names'] framing = 101 + (num_vars * 10) # Find number of levels num_levels = len(set(input_sample[:, 1])) ou...
python
def sample_histograms(fig, input_sample, problem, param_dict): '''Plots a set of subplots of histograms of the input sample ''' num_vars = problem['num_vars'] names = problem['names'] framing = 101 + (num_vars * 10) # Find number of levels num_levels = len(set(input_sample[:, 1])) ou...
[ "def", "sample_histograms", "(", "fig", ",", "input_sample", ",", "problem", ",", "param_dict", ")", ":", "num_vars", "=", "problem", "[", "'num_vars'", "]", "names", "=", "problem", "[", "'names'", "]", "framing", "=", "101", "+", "(", "num_vars", "*", ...
Plots a set of subplots of histograms of the input sample
[ "Plots", "a", "set", "of", "subplots", "of", "histograms", "of", "the", "input", "sample" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/plotting/morris.py#L105-L138
train
SALib/SALib
src/SALib/sample/ff.py
extend_bounds
def extend_bounds(problem): """Extends the problem bounds to the nearest power of two Arguments ========= problem : dict The problem definition """ num_vars = problem['num_vars'] num_ff_vars = 2 ** find_smallest(num_vars) num_dummy_variables = num_ff_vars - num_vars bounds...
python
def extend_bounds(problem): """Extends the problem bounds to the nearest power of two Arguments ========= problem : dict The problem definition """ num_vars = problem['num_vars'] num_ff_vars = 2 ** find_smallest(num_vars) num_dummy_variables = num_ff_vars - num_vars bounds...
[ "def", "extend_bounds", "(", "problem", ")", ":", "num_vars", "=", "problem", "[", "'num_vars'", "]", "num_ff_vars", "=", "2", "**", "find_smallest", "(", "num_vars", ")", "num_dummy_variables", "=", "num_ff_vars", "-", "num_vars", "bounds", "=", "list", "(", ...
Extends the problem bounds to the nearest power of two Arguments ========= problem : dict The problem definition
[ "Extends", "the", "problem", "bounds", "to", "the", "nearest", "power", "of", "two" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/ff.py#L33-L56
train
SALib/SALib
src/SALib/sample/ff.py
generate_contrast
def generate_contrast(problem): """Generates the raw sample from the problem file Arguments ========= problem : dict The problem definition """ num_vars = problem['num_vars'] # Find the smallest n, such that num_vars < k k = [2 ** n for n in range(16)] k_chosen = 2 ** find...
python
def generate_contrast(problem): """Generates the raw sample from the problem file Arguments ========= problem : dict The problem definition """ num_vars = problem['num_vars'] # Find the smallest n, such that num_vars < k k = [2 ** n for n in range(16)] k_chosen = 2 ** find...
[ "def", "generate_contrast", "(", "problem", ")", ":", "num_vars", "=", "problem", "[", "'num_vars'", "]", "# Find the smallest n, such that num_vars < k", "k", "=", "[", "2", "**", "n", "for", "n", "in", "range", "(", "16", ")", "]", "k_chosen", "=", "2", ...
Generates the raw sample from the problem file Arguments ========= problem : dict The problem definition
[ "Generates", "the", "raw", "sample", "from", "the", "problem", "file" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/ff.py#L59-L77
train
SALib/SALib
src/SALib/sample/ff.py
sample
def sample(problem, seed=None): """Generates model inputs using a fractional factorial sample Returns a NumPy matrix containing the model inputs required for a fractional factorial analysis. The resulting matrix has D columns, where D is smallest power of 2 that is greater than the number of parame...
python
def sample(problem, seed=None): """Generates model inputs using a fractional factorial sample Returns a NumPy matrix containing the model inputs required for a fractional factorial analysis. The resulting matrix has D columns, where D is smallest power of 2 that is greater than the number of parame...
[ "def", "sample", "(", "problem", ",", "seed", "=", "None", ")", ":", "if", "seed", ":", "np", ".", "random", ".", "seed", "(", "seed", ")", "contrast", "=", "generate_contrast", "(", "problem", ")", "sample", "=", "np", ".", "array", "(", "(", "con...
Generates model inputs using a fractional factorial sample Returns a NumPy matrix containing the model inputs required for a fractional factorial analysis. The resulting matrix has D columns, where D is smallest power of 2 that is greater than the number of parameters. These model inputs are intend...
[ "Generates", "model", "inputs", "using", "a", "fractional", "factorial", "sample" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/ff.py#L80-L113
train
SALib/SALib
src/SALib/sample/ff.py
cli_action
def cli_action(args): """Run sampling method Parameters ---------- args : argparse namespace """ problem = read_param_file(args.paramfile) param_values = sample(problem, seed=args.seed) np.savetxt(args.output, param_values, delimiter=args.delimiter, fmt='%.' + str(args.pr...
python
def cli_action(args): """Run sampling method Parameters ---------- args : argparse namespace """ problem = read_param_file(args.paramfile) param_values = sample(problem, seed=args.seed) np.savetxt(args.output, param_values, delimiter=args.delimiter, fmt='%.' + str(args.pr...
[ "def", "cli_action", "(", "args", ")", ":", "problem", "=", "read_param_file", "(", "args", ".", "paramfile", ")", "param_values", "=", "sample", "(", "problem", ",", "seed", "=", "args", ".", "seed", ")", "np", ".", "savetxt", "(", "args", ".", "outpu...
Run sampling method Parameters ---------- args : argparse namespace
[ "Run", "sampling", "method" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/ff.py#L135-L145
train
SALib/SALib
src/SALib/sample/common_args.py
setup
def setup(parser): """Add common sampling options to CLI parser. Parameters ---------- parser : argparse object Returns ---------- Updated argparse object """ parser.add_argument( '-p', '--paramfile', type=str, required=True, help='Parameter Range File') parser....
python
def setup(parser): """Add common sampling options to CLI parser. Parameters ---------- parser : argparse object Returns ---------- Updated argparse object """ parser.add_argument( '-p', '--paramfile', type=str, required=True, help='Parameter Range File') parser....
[ "def", "setup", "(", "parser", ")", ":", "parser", ".", "add_argument", "(", "'-p'", ",", "'--paramfile'", ",", "type", "=", "str", ",", "required", "=", "True", ",", "help", "=", "'Parameter Range File'", ")", "parser", ".", "add_argument", "(", "'-o'", ...
Add common sampling options to CLI parser. Parameters ---------- parser : argparse object Returns ---------- Updated argparse object
[ "Add", "common", "sampling", "options", "to", "CLI", "parser", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/common_args.py#L4-L29
train
SALib/SALib
src/SALib/sample/common_args.py
run_cli
def run_cli(cli_parser, run_sample, known_args=None): """Run sampling with CLI arguments. Parameters ---------- cli_parser : function Function to add method specific arguments to parser run_sample: function Method specific function that runs the sampling known_args: list [option...
python
def run_cli(cli_parser, run_sample, known_args=None): """Run sampling with CLI arguments. Parameters ---------- cli_parser : function Function to add method specific arguments to parser run_sample: function Method specific function that runs the sampling known_args: list [option...
[ "def", "run_cli", "(", "cli_parser", ",", "run_sample", ",", "known_args", "=", "None", ")", ":", "parser", "=", "create", "(", "cli_parser", ")", "args", "=", "parser", ".", "parse_args", "(", "known_args", ")", "run_sample", "(", "args", ")" ]
Run sampling with CLI arguments. Parameters ---------- cli_parser : function Function to add method specific arguments to parser run_sample: function Method specific function that runs the sampling known_args: list [optional] Additional arguments to parse Returns --...
[ "Run", "sampling", "with", "CLI", "arguments", "." ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/common_args.py#L54-L73
train
SALib/SALib
src/SALib/sample/morris/strategy.py
Strategy.run_checks
def run_checks(number_samples, k_choices): """Runs checks on `k_choices` """ assert isinstance(k_choices, int), \ "Number of optimal trajectories should be an integer" if k_choices < 2: raise ValueError( "The number of optimal trajectories must be...
python
def run_checks(number_samples, k_choices): """Runs checks on `k_choices` """ assert isinstance(k_choices, int), \ "Number of optimal trajectories should be an integer" if k_choices < 2: raise ValueError( "The number of optimal trajectories must be...
[ "def", "run_checks", "(", "number_samples", ",", "k_choices", ")", ":", "assert", "isinstance", "(", "k_choices", ",", "int", ")", ",", "\"Number of optimal trajectories should be an integer\"", "if", "k_choices", "<", "2", ":", "raise", "ValueError", "(", "\"The nu...
Runs checks on `k_choices`
[ "Runs", "checks", "on", "k_choices" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L123-L135
train
SALib/SALib
src/SALib/sample/morris/strategy.py
Strategy._make_index_list
def _make_index_list(num_samples, num_params, num_groups=None): """Identify indices of input sample associated with each trajectory For each trajectory, identifies the indexes of the input sample which is a function of the number of factors/groups and the number of samples Arguments ...
python
def _make_index_list(num_samples, num_params, num_groups=None): """Identify indices of input sample associated with each trajectory For each trajectory, identifies the indexes of the input sample which is a function of the number of factors/groups and the number of samples Arguments ...
[ "def", "_make_index_list", "(", "num_samples", ",", "num_params", ",", "num_groups", "=", "None", ")", ":", "if", "num_groups", "is", "None", ":", "num_groups", "=", "num_params", "index_list", "=", "[", "]", "for", "j", "in", "range", "(", "num_samples", ...
Identify indices of input sample associated with each trajectory For each trajectory, identifies the indexes of the input sample which is a function of the number of factors/groups and the number of samples Arguments --------- num_samples : int The number of traject...
[ "Identify", "indices", "of", "input", "sample", "associated", "with", "each", "trajectory" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L138-L170
train
SALib/SALib
src/SALib/sample/morris/strategy.py
Strategy.compile_output
def compile_output(self, input_sample, num_samples, num_params, maximum_combo, num_groups=None): """Picks the trajectories from the input Arguments --------- input_sample : numpy.ndarray num_samples : int num_params : int maximum_combo : li...
python
def compile_output(self, input_sample, num_samples, num_params, maximum_combo, num_groups=None): """Picks the trajectories from the input Arguments --------- input_sample : numpy.ndarray num_samples : int num_params : int maximum_combo : li...
[ "def", "compile_output", "(", "self", ",", "input_sample", ",", "num_samples", ",", "num_params", ",", "maximum_combo", ",", "num_groups", "=", "None", ")", ":", "if", "num_groups", "is", "None", ":", "num_groups", "=", "num_params", "self", ".", "check_input_...
Picks the trajectories from the input Arguments --------- input_sample : numpy.ndarray num_samples : int num_params : int maximum_combo : list num_groups : int
[ "Picks", "the", "trajectories", "from", "the", "input" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L172-L198
train
SALib/SALib
src/SALib/sample/morris/strategy.py
Strategy.check_input_sample
def check_input_sample(input_sample, num_params, num_samples): """Check the `input_sample` is valid Checks input sample is: - the correct size - values between 0 and 1 Arguments --------- input_sample : numpy.ndarray num_params : int num_...
python
def check_input_sample(input_sample, num_params, num_samples): """Check the `input_sample` is valid Checks input sample is: - the correct size - values between 0 and 1 Arguments --------- input_sample : numpy.ndarray num_params : int num_...
[ "def", "check_input_sample", "(", "input_sample", ",", "num_params", ",", "num_samples", ")", ":", "assert", "type", "(", "input_sample", ")", "==", "np", ".", "ndarray", ",", "\"Input sample is not an numpy array\"", "assert", "input_sample", ".", "shape", "[", "...
Check the `input_sample` is valid Checks input sample is: - the correct size - values between 0 and 1 Arguments --------- input_sample : numpy.ndarray num_params : int num_samples : int
[ "Check", "the", "input_sample", "is", "valid" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L201-L219
train
SALib/SALib
src/SALib/sample/morris/strategy.py
Strategy.compute_distance
def compute_distance(m, l): '''Compute distance between two trajectories Returns ------- numpy.ndarray ''' if np.shape(m) != np.shape(l): raise ValueError("Input matrices are different sizes") if np.array_equal(m, l): # print("Trajectory ...
python
def compute_distance(m, l): '''Compute distance between two trajectories Returns ------- numpy.ndarray ''' if np.shape(m) != np.shape(l): raise ValueError("Input matrices are different sizes") if np.array_equal(m, l): # print("Trajectory ...
[ "def", "compute_distance", "(", "m", ",", "l", ")", ":", "if", "np", ".", "shape", "(", "m", ")", "!=", "np", ".", "shape", "(", "l", ")", ":", "raise", "ValueError", "(", "\"Input matrices are different sizes\"", ")", "if", "np", ".", "array_equal", "...
Compute distance between two trajectories Returns ------- numpy.ndarray
[ "Compute", "distance", "between", "two", "trajectories" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L222-L238
train
SALib/SALib
src/SALib/sample/morris/strategy.py
Strategy.compute_distance_matrix
def compute_distance_matrix(self, input_sample, num_samples, num_params, num_groups=None, local_optimization=False): """Computes the distance between each and every trajectory Each entry in the matrix represents the sum of the geometric di...
python
def compute_distance_matrix(self, input_sample, num_samples, num_params, num_groups=None, local_optimization=False): """Computes the distance between each and every trajectory Each entry in the matrix represents the sum of the geometric di...
[ "def", "compute_distance_matrix", "(", "self", ",", "input_sample", ",", "num_samples", ",", "num_params", ",", "num_groups", "=", "None", ",", "local_optimization", "=", "False", ")", ":", "if", "num_groups", ":", "self", ".", "check_input_sample", "(", "input_...
Computes the distance between each and every trajectory Each entry in the matrix represents the sum of the geometric distances between all the pairs of points of the two trajectories If the `groups` argument is filled, then the distances are still calculated for each trajectory, ...
[ "Computes", "the", "distance", "between", "each", "and", "every", "trajectory" ]
9744d73bb17cfcffc8282c7dc4a727efdc4bea3f
https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L240-L290
train
nicodv/kmodes
kmodes/kmodes.py
move_point_cat
def move_point_cat(point, ipoint, to_clust, from_clust, cl_attr_freq, membship, centroids): """Move point between clusters, categorical attributes.""" membship[to_clust, ipoint] = 1 membship[from_clust, ipoint] = 0 # Update frequencies of attributes in cluster. for iattr, curattr ...
python
def move_point_cat(point, ipoint, to_clust, from_clust, cl_attr_freq, membship, centroids): """Move point between clusters, categorical attributes.""" membship[to_clust, ipoint] = 1 membship[from_clust, ipoint] = 0 # Update frequencies of attributes in cluster. for iattr, curattr ...
[ "def", "move_point_cat", "(", "point", ",", "ipoint", ",", "to_clust", ",", "from_clust", ",", "cl_attr_freq", ",", "membship", ",", "centroids", ")", ":", "membship", "[", "to_clust", ",", "ipoint", "]", "=", "1", "membship", "[", "from_clust", ",", "ipoi...
Move point between clusters, categorical attributes.
[ "Move", "point", "between", "clusters", "categorical", "attributes", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L83-L112
train
nicodv/kmodes
kmodes/kmodes.py
_labels_cost
def _labels_cost(X, centroids, dissim, membship=None): """Calculate labels and cost function given a matrix of points and a list of centroids for the k-modes algorithm. """ X = check_array(X) n_points = X.shape[0] cost = 0. labels = np.empty(n_points, dtype=np.uint16) for ipoint, curpo...
python
def _labels_cost(X, centroids, dissim, membship=None): """Calculate labels and cost function given a matrix of points and a list of centroids for the k-modes algorithm. """ X = check_array(X) n_points = X.shape[0] cost = 0. labels = np.empty(n_points, dtype=np.uint16) for ipoint, curpo...
[ "def", "_labels_cost", "(", "X", ",", "centroids", ",", "dissim", ",", "membship", "=", "None", ")", ":", "X", "=", "check_array", "(", "X", ")", "n_points", "=", "X", ".", "shape", "[", "0", "]", "cost", "=", "0.", "labels", "=", "np", ".", "emp...
Calculate labels and cost function given a matrix of points and a list of centroids for the k-modes algorithm.
[ "Calculate", "labels", "and", "cost", "function", "given", "a", "matrix", "of", "points", "and", "a", "list", "of", "centroids", "for", "the", "k", "-", "modes", "algorithm", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L115-L131
train
nicodv/kmodes
kmodes/kmodes.py
_k_modes_iter
def _k_modes_iter(X, centroids, cl_attr_freq, membship, dissim, random_state): """Single iteration of k-modes clustering algorithm""" moves = 0 for ipoint, curpoint in enumerate(X): clust = np.argmin(dissim(centroids, curpoint, X=X, membship=membship)) if membship[clust, ipoint]: ...
python
def _k_modes_iter(X, centroids, cl_attr_freq, membship, dissim, random_state): """Single iteration of k-modes clustering algorithm""" moves = 0 for ipoint, curpoint in enumerate(X): clust = np.argmin(dissim(centroids, curpoint, X=X, membship=membship)) if membship[clust, ipoint]: ...
[ "def", "_k_modes_iter", "(", "X", ",", "centroids", ",", "cl_attr_freq", ",", "membship", ",", "dissim", ",", "random_state", ")", ":", "moves", "=", "0", "for", "ipoint", ",", "curpoint", "in", "enumerate", "(", "X", ")", ":", "clust", "=", "np", ".",...
Single iteration of k-modes clustering algorithm
[ "Single", "iteration", "of", "k", "-", "modes", "clustering", "algorithm" ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L134-L162
train
nicodv/kmodes
kmodes/kmodes.py
k_modes
def k_modes(X, n_clusters, max_iter, dissim, init, n_init, verbose, random_state, n_jobs): """k-modes algorithm""" random_state = check_random_state(random_state) if sparse.issparse(X): raise TypeError("k-modes does not support sparse data.") X = check_array(X, dtype=None) # Convert the ca...
python
def k_modes(X, n_clusters, max_iter, dissim, init, n_init, verbose, random_state, n_jobs): """k-modes algorithm""" random_state = check_random_state(random_state) if sparse.issparse(X): raise TypeError("k-modes does not support sparse data.") X = check_array(X, dtype=None) # Convert the ca...
[ "def", "k_modes", "(", "X", ",", "n_clusters", ",", "max_iter", ",", "dissim", ",", "init", ",", "n_init", ",", "verbose", ",", "random_state", ",", "n_jobs", ")", ":", "random_state", "=", "check_random_state", "(", "random_state", ")", "if", "sparse", "....
k-modes algorithm
[ "k", "-", "modes", "algorithm" ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L243-L287
train
nicodv/kmodes
kmodes/kmodes.py
KModes.fit
def fit(self, X, y=None, **kwargs): """Compute k-modes clustering. Parameters ---------- X : array-like, shape=[n_samples, n_features] """ X = pandas_to_numpy(X) random_state = check_random_state(self.random_state) self._enc_cluster_centroids, self._enc_...
python
def fit(self, X, y=None, **kwargs): """Compute k-modes clustering. Parameters ---------- X : array-like, shape=[n_samples, n_features] """ X = pandas_to_numpy(X) random_state = check_random_state(self.random_state) self._enc_cluster_centroids, self._enc_...
[ "def", "fit", "(", "self", ",", "X", ",", "y", "=", "None", ",", "*", "*", "kwargs", ")", ":", "X", "=", "pandas_to_numpy", "(", "X", ")", "random_state", "=", "check_random_state", "(", "self", ".", "random_state", ")", "self", ".", "_enc_cluster_cent...
Compute k-modes clustering. Parameters ---------- X : array-like, shape=[n_samples, n_features]
[ "Compute", "k", "-", "modes", "clustering", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L381-L401
train
nicodv/kmodes
kmodes/kmodes.py
KModes.fit_predict
def fit_predict(self, X, y=None, **kwargs): """Compute cluster centroids and predict cluster index for each sample. Convenience method; equivalent to calling fit(X) followed by predict(X). """ return self.fit(X, **kwargs).predict(X, **kwargs)
python
def fit_predict(self, X, y=None, **kwargs): """Compute cluster centroids and predict cluster index for each sample. Convenience method; equivalent to calling fit(X) followed by predict(X). """ return self.fit(X, **kwargs).predict(X, **kwargs)
[ "def", "fit_predict", "(", "self", ",", "X", ",", "y", "=", "None", ",", "*", "*", "kwargs", ")", ":", "return", "self", ".", "fit", "(", "X", ",", "*", "*", "kwargs", ")", ".", "predict", "(", "X", ",", "*", "*", "kwargs", ")" ]
Compute cluster centroids and predict cluster index for each sample. Convenience method; equivalent to calling fit(X) followed by predict(X).
[ "Compute", "cluster", "centroids", "and", "predict", "cluster", "index", "for", "each", "sample", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L403-L409
train
nicodv/kmodes
kmodes/util/__init__.py
get_max_value_key
def get_max_value_key(dic): """Gets the key for the maximum value in a dict.""" v = np.array(list(dic.values())) k = np.array(list(dic.keys())) maxima = np.where(v == np.max(v))[0] if len(maxima) == 1: return k[maxima[0]] else: # In order to be consistent, always selects the min...
python
def get_max_value_key(dic): """Gets the key for the maximum value in a dict.""" v = np.array(list(dic.values())) k = np.array(list(dic.keys())) maxima = np.where(v == np.max(v))[0] if len(maxima) == 1: return k[maxima[0]] else: # In order to be consistent, always selects the min...
[ "def", "get_max_value_key", "(", "dic", ")", ":", "v", "=", "np", ".", "array", "(", "list", "(", "dic", ".", "values", "(", ")", ")", ")", "k", "=", "np", ".", "array", "(", "list", "(", "dic", ".", "keys", "(", ")", ")", ")", "maxima", "=",...
Gets the key for the maximum value in a dict.
[ "Gets", "the", "key", "for", "the", "maximum", "value", "in", "a", "dict", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/__init__.py#L12-L23
train
nicodv/kmodes
kmodes/util/__init__.py
decode_centroids
def decode_centroids(encoded, mapping): """Decodes the encoded centroids array back to the original data labels using a list of mappings. """ decoded = [] for ii in range(encoded.shape[1]): # Invert the mapping so that we can decode. inv_mapping = {v: k for k, v in mapping[ii].items(...
python
def decode_centroids(encoded, mapping): """Decodes the encoded centroids array back to the original data labels using a list of mappings. """ decoded = [] for ii in range(encoded.shape[1]): # Invert the mapping so that we can decode. inv_mapping = {v: k for k, v in mapping[ii].items(...
[ "def", "decode_centroids", "(", "encoded", ",", "mapping", ")", ":", "decoded", "=", "[", "]", "for", "ii", "in", "range", "(", "encoded", ".", "shape", "[", "1", "]", ")", ":", "# Invert the mapping so that we can decode.", "inv_mapping", "=", "{", "v", "...
Decodes the encoded centroids array back to the original data labels using a list of mappings.
[ "Decodes", "the", "encoded", "centroids", "array", "back", "to", "the", "original", "data", "labels", "using", "a", "list", "of", "mappings", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/__init__.py#L54-L63
train
nicodv/kmodes
kmodes/kprototypes.py
move_point_num
def move_point_num(point, to_clust, from_clust, cl_attr_sum, cl_memb_sum): """Move point between clusters, numerical attributes.""" # Update sum of attributes in cluster. for iattr, curattr in enumerate(point): cl_attr_sum[to_clust][iattr] += curattr cl_attr_sum[from_clust][iattr] -= curattr...
python
def move_point_num(point, to_clust, from_clust, cl_attr_sum, cl_memb_sum): """Move point between clusters, numerical attributes.""" # Update sum of attributes in cluster. for iattr, curattr in enumerate(point): cl_attr_sum[to_clust][iattr] += curattr cl_attr_sum[from_clust][iattr] -= curattr...
[ "def", "move_point_num", "(", "point", ",", "to_clust", ",", "from_clust", ",", "cl_attr_sum", ",", "cl_memb_sum", ")", ":", "# Update sum of attributes in cluster.", "for", "iattr", ",", "curattr", "in", "enumerate", "(", "point", ")", ":", "cl_attr_sum", "[", ...
Move point between clusters, numerical attributes.
[ "Move", "point", "between", "clusters", "numerical", "attributes", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L28-L37
train
nicodv/kmodes
kmodes/kprototypes.py
_split_num_cat
def _split_num_cat(X, categorical): """Extract numerical and categorical columns. Convert to numpy arrays, if needed. :param X: Feature matrix :param categorical: Indices of categorical columns """ Xnum = np.asanyarray(X[:, [ii for ii in range(X.shape[1]) if ii no...
python
def _split_num_cat(X, categorical): """Extract numerical and categorical columns. Convert to numpy arrays, if needed. :param X: Feature matrix :param categorical: Indices of categorical columns """ Xnum = np.asanyarray(X[:, [ii for ii in range(X.shape[1]) if ii no...
[ "def", "_split_num_cat", "(", "X", ",", "categorical", ")", ":", "Xnum", "=", "np", ".", "asanyarray", "(", "X", "[", ":", ",", "[", "ii", "for", "ii", "in", "range", "(", "X", ".", "shape", "[", "1", "]", ")", "if", "ii", "not", "in", "categor...
Extract numerical and categorical columns. Convert to numpy arrays, if needed. :param X: Feature matrix :param categorical: Indices of categorical columns
[ "Extract", "numerical", "and", "categorical", "columns", ".", "Convert", "to", "numpy", "arrays", "if", "needed", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L40-L50
train
nicodv/kmodes
kmodes/kprototypes.py
_labels_cost
def _labels_cost(Xnum, Xcat, centroids, num_dissim, cat_dissim, gamma, membship=None): """Calculate labels and cost function given a matrix of points and a list of centroids for the k-prototypes algorithm. """ n_points = Xnum.shape[0] Xnum = check_array(Xnum) cost = 0. labels = np.empty(n_...
python
def _labels_cost(Xnum, Xcat, centroids, num_dissim, cat_dissim, gamma, membship=None): """Calculate labels and cost function given a matrix of points and a list of centroids for the k-prototypes algorithm. """ n_points = Xnum.shape[0] Xnum = check_array(Xnum) cost = 0. labels = np.empty(n_...
[ "def", "_labels_cost", "(", "Xnum", ",", "Xcat", ",", "centroids", ",", "num_dissim", ",", "cat_dissim", ",", "gamma", ",", "membship", "=", "None", ")", ":", "n_points", "=", "Xnum", ".", "shape", "[", "0", "]", "Xnum", "=", "check_array", "(", "Xnum"...
Calculate labels and cost function given a matrix of points and a list of centroids for the k-prototypes algorithm.
[ "Calculate", "labels", "and", "cost", "function", "given", "a", "matrix", "of", "points", "and", "a", "list", "of", "centroids", "for", "the", "k", "-", "prototypes", "algorithm", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L53-L73
train
nicodv/kmodes
kmodes/kprototypes.py
_k_prototypes_iter
def _k_prototypes_iter(Xnum, Xcat, centroids, cl_attr_sum, cl_memb_sum, cl_attr_freq, membship, num_dissim, cat_dissim, gamma, random_state): """Single iteration of the k-prototypes algorithm""" moves = 0 for ipoint in range(Xnum.shape[0]): clust = np.argmin( num_d...
python
def _k_prototypes_iter(Xnum, Xcat, centroids, cl_attr_sum, cl_memb_sum, cl_attr_freq, membship, num_dissim, cat_dissim, gamma, random_state): """Single iteration of the k-prototypes algorithm""" moves = 0 for ipoint in range(Xnum.shape[0]): clust = np.argmin( num_d...
[ "def", "_k_prototypes_iter", "(", "Xnum", ",", "Xcat", ",", "centroids", ",", "cl_attr_sum", ",", "cl_memb_sum", ",", "cl_attr_freq", ",", "membship", ",", "num_dissim", ",", "cat_dissim", ",", "gamma", ",", "random_state", ")", ":", "moves", "=", "0", "for"...
Single iteration of the k-prototypes algorithm
[ "Single", "iteration", "of", "the", "k", "-", "prototypes", "algorithm" ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L76-L127
train
nicodv/kmodes
kmodes/kprototypes.py
k_prototypes
def k_prototypes(X, categorical, n_clusters, max_iter, num_dissim, cat_dissim, gamma, init, n_init, verbose, random_state, n_jobs): """k-prototypes algorithm""" random_state = check_random_state(random_state) if sparse.issparse(X): raise TypeError("k-prototypes does not support spar...
python
def k_prototypes(X, categorical, n_clusters, max_iter, num_dissim, cat_dissim, gamma, init, n_init, verbose, random_state, n_jobs): """k-prototypes algorithm""" random_state = check_random_state(random_state) if sparse.issparse(X): raise TypeError("k-prototypes does not support spar...
[ "def", "k_prototypes", "(", "X", ",", "categorical", ",", "n_clusters", ",", "max_iter", ",", "num_dissim", ",", "cat_dissim", ",", "gamma", ",", "init", ",", "n_init", ",", "verbose", ",", "random_state", ",", "n_jobs", ")", ":", "random_state", "=", "che...
k-prototypes algorithm
[ "k", "-", "prototypes", "algorithm" ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L255-L327
train
nicodv/kmodes
kmodes/kprototypes.py
KPrototypes.fit
def fit(self, X, y=None, categorical=None): """Compute k-prototypes clustering. Parameters ---------- X : array-like, shape=[n_samples, n_features] categorical : Index of columns that contain categorical data """ if categorical is not None: assert isi...
python
def fit(self, X, y=None, categorical=None): """Compute k-prototypes clustering. Parameters ---------- X : array-like, shape=[n_samples, n_features] categorical : Index of columns that contain categorical data """ if categorical is not None: assert isi...
[ "def", "fit", "(", "self", ",", "X", ",", "y", "=", "None", ",", "categorical", "=", "None", ")", ":", "if", "categorical", "is", "not", "None", ":", "assert", "isinstance", "(", "categorical", ",", "(", "int", ",", "list", ",", "tuple", ")", ")", ...
Compute k-prototypes clustering. Parameters ---------- X : array-like, shape=[n_samples, n_features] categorical : Index of columns that contain categorical data
[ "Compute", "k", "-", "prototypes", "clustering", "." ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L431-L463
train
nicodv/kmodes
kmodes/util/dissim.py
euclidean_dissim
def euclidean_dissim(a, b, **_): """Euclidean distance dissimilarity function""" if np.isnan(a).any() or np.isnan(b).any(): raise ValueError("Missing values detected in numerical columns.") return np.sum((a - b) ** 2, axis=1)
python
def euclidean_dissim(a, b, **_): """Euclidean distance dissimilarity function""" if np.isnan(a).any() or np.isnan(b).any(): raise ValueError("Missing values detected in numerical columns.") return np.sum((a - b) ** 2, axis=1)
[ "def", "euclidean_dissim", "(", "a", ",", "b", ",", "*", "*", "_", ")", ":", "if", "np", ".", "isnan", "(", "a", ")", ".", "any", "(", ")", "or", "np", ".", "isnan", "(", "b", ")", ".", "any", "(", ")", ":", "raise", "ValueError", "(", "\"M...
Euclidean distance dissimilarity function
[ "Euclidean", "distance", "dissimilarity", "function" ]
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/dissim.py#L13-L17
train
nicodv/kmodes
kmodes/util/dissim.py
ng_dissim
def ng_dissim(a, b, X=None, membship=None): """Ng et al.'s dissimilarity measure, as presented in Michael K. Ng, Mark Junjie Li, Joshua Zhexue Huang, and Zengyou He, "On the Impact of Dissimilarity Measure in k-Modes Clustering Algorithm", IEEE Transactions on Pattern Analysis and Machine Intelligence, ...
python
def ng_dissim(a, b, X=None, membship=None): """Ng et al.'s dissimilarity measure, as presented in Michael K. Ng, Mark Junjie Li, Joshua Zhexue Huang, and Zengyou He, "On the Impact of Dissimilarity Measure in k-Modes Clustering Algorithm", IEEE Transactions on Pattern Analysis and Machine Intelligence, ...
[ "def", "ng_dissim", "(", "a", ",", "b", ",", "X", "=", "None", ",", "membship", "=", "None", ")", ":", "# Without membership, revert to matching dissimilarity", "if", "membship", "is", "None", ":", "return", "matching_dissim", "(", "a", ",", "b", ")", "def",...
Ng et al.'s dissimilarity measure, as presented in Michael K. Ng, Mark Junjie Li, Joshua Zhexue Huang, and Zengyou He, "On the Impact of Dissimilarity Measure in k-Modes Clustering Algorithm", IEEE Transactions on Pattern Analysis and Machine Intelligence, Vol. 29, No. 3, January, 2007 This functio...
[ "Ng", "et", "al", ".", "s", "dissimilarity", "measure", "as", "presented", "in", "Michael", "K", ".", "Ng", "Mark", "Junjie", "Li", "Joshua", "Zhexue", "Huang", "and", "Zengyou", "He", "On", "the", "Impact", "of", "Dissimilarity", "Measure", "in", "k", "...
cdb19fe5448aba1bf501626694bb52e68eafab45
https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/dissim.py#L20-L58
train
Bogdanp/dramatiq
dramatiq/results/backend.py
ResultBackend.store_result
def store_result(self, message, result: Result, ttl: int) -> None: """Store a result in the backend. Parameters: message(Message) result(object): Must be serializable. ttl(int): The maximum amount of time the result may be stored in the backend for. """...
python
def store_result(self, message, result: Result, ttl: int) -> None: """Store a result in the backend. Parameters: message(Message) result(object): Must be serializable. ttl(int): The maximum amount of time the result may be stored in the backend for. """...
[ "def", "store_result", "(", "self", ",", "message", ",", "result", ":", "Result", ",", "ttl", ":", "int", ")", "->", "None", ":", "message_key", "=", "self", ".", "build_message_key", "(", "message", ")", "return", "self", ".", "_store", "(", "message_ke...
Store a result in the backend. Parameters: message(Message) result(object): Must be serializable. ttl(int): The maximum amount of time the result may be stored in the backend for.
[ "Store", "a", "result", "in", "the", "backend", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/results/backend.py#L98-L108
train
Bogdanp/dramatiq
dramatiq/results/backend.py
ResultBackend.build_message_key
def build_message_key(self, message) -> str: """Given a message, return its globally-unique key. Parameters: message(Message) Returns: str """ message_key = "%(namespace)s:%(queue_name)s:%(actor_name)s:%(message_id)s" % { "namespace": self.namesp...
python
def build_message_key(self, message) -> str: """Given a message, return its globally-unique key. Parameters: message(Message) Returns: str """ message_key = "%(namespace)s:%(queue_name)s:%(actor_name)s:%(message_id)s" % { "namespace": self.namesp...
[ "def", "build_message_key", "(", "self", ",", "message", ")", "->", "str", ":", "message_key", "=", "\"%(namespace)s:%(queue_name)s:%(actor_name)s:%(message_id)s\"", "%", "{", "\"namespace\"", ":", "self", ".", "namespace", ",", "\"queue_name\"", ":", "q_name", "(", ...
Given a message, return its globally-unique key. Parameters: message(Message) Returns: str
[ "Given", "a", "message", "return", "its", "globally", "-", "unique", "key", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/results/backend.py#L110-L125
train
Bogdanp/dramatiq
dramatiq/results/backend.py
ResultBackend._store
def _store(self, message_key: str, result: Result, ttl: int) -> None: # pragma: no cover """Store a result in the backend. Subclasses may implement this method if they want to use the default implementation of set_result. """ raise NotImplementedError("%(classname)r does not im...
python
def _store(self, message_key: str, result: Result, ttl: int) -> None: # pragma: no cover """Store a result in the backend. Subclasses may implement this method if they want to use the default implementation of set_result. """ raise NotImplementedError("%(classname)r does not im...
[ "def", "_store", "(", "self", ",", "message_key", ":", "str", ",", "result", ":", "Result", ",", "ttl", ":", "int", ")", "->", "None", ":", "# pragma: no cover", "raise", "NotImplementedError", "(", "\"%(classname)r does not implement _store()\"", "%", "{", "\"c...
Store a result in the backend. Subclasses may implement this method if they want to use the default implementation of set_result.
[ "Store", "a", "result", "in", "the", "backend", ".", "Subclasses", "may", "implement", "this", "method", "if", "they", "want", "to", "use", "the", "default", "implementation", "of", "set_result", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/results/backend.py#L136-L143
train
Bogdanp/dramatiq
dramatiq/rate_limits/rate_limiter.py
RateLimiter.acquire
def acquire(self, *, raise_on_failure=True): """Attempt to acquire a slot under this rate limiter. Parameters: raise_on_failure(bool): Whether or not failures should raise an exception. If this is false, the context manager will instead return a boolean value represen...
python
def acquire(self, *, raise_on_failure=True): """Attempt to acquire a slot under this rate limiter. Parameters: raise_on_failure(bool): Whether or not failures should raise an exception. If this is false, the context manager will instead return a boolean value represen...
[ "def", "acquire", "(", "self", ",", "*", ",", "raise_on_failure", "=", "True", ")", ":", "acquired", "=", "False", "try", ":", "acquired", "=", "self", ".", "_acquire", "(", ")", "if", "raise_on_failure", "and", "not", "acquired", ":", "raise", "RateLimi...
Attempt to acquire a slot under this rate limiter. Parameters: raise_on_failure(bool): Whether or not failures should raise an exception. If this is false, the context manager will instead return a boolean value representing whether or not the rate limit slot was ...
[ "Attempt", "to", "acquire", "a", "slot", "under", "this", "rate", "limiter", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/rate_limits/rate_limiter.py#L56-L78
train
Bogdanp/dramatiq
dramatiq/middleware/prometheus.py
flock
def flock(path): """Attempt to acquire a POSIX file lock. """ with open(path, "w+") as lf: try: fcntl.flock(lf, fcntl.LOCK_EX | fcntl.LOCK_NB) acquired = True yield acquired except OSError: acquired = False yield acquired ...
python
def flock(path): """Attempt to acquire a POSIX file lock. """ with open(path, "w+") as lf: try: fcntl.flock(lf, fcntl.LOCK_EX | fcntl.LOCK_NB) acquired = True yield acquired except OSError: acquired = False yield acquired ...
[ "def", "flock", "(", "path", ")", ":", "with", "open", "(", "path", ",", "\"w+\"", ")", "as", "lf", ":", "try", ":", "fcntl", ".", "flock", "(", "lf", ",", "fcntl", ".", "LOCK_EX", "|", "fcntl", ".", "LOCK_NB", ")", "acquired", "=", "True", "yiel...
Attempt to acquire a POSIX file lock.
[ "Attempt", "to", "acquire", "a", "POSIX", "file", "lock", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/middleware/prometheus.py#L227-L242
train
Bogdanp/dramatiq
dramatiq/message.py
Message.copy
def copy(self, **attributes): """Create a copy of this message. """ updated_options = attributes.pop("options", {}) options = self.options.copy() options.update(updated_options) return self._replace(**attributes, options=options)
python
def copy(self, **attributes): """Create a copy of this message. """ updated_options = attributes.pop("options", {}) options = self.options.copy() options.update(updated_options) return self._replace(**attributes, options=options)
[ "def", "copy", "(", "self", ",", "*", "*", "attributes", ")", ":", "updated_options", "=", "attributes", ".", "pop", "(", "\"options\"", ",", "{", "}", ")", "options", "=", "self", ".", "options", ".", "copy", "(", ")", "options", ".", "update", "(",...
Create a copy of this message.
[ "Create", "a", "copy", "of", "this", "message", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/message.py#L103-L109
train
Bogdanp/dramatiq
dramatiq/message.py
Message.get_result
def get_result(self, *, backend=None, block=False, timeout=None): """Get the result associated with this message from a result backend. Warning: If you use multiple result backends or brokers you should always pass the backend parameter. This method is only able t...
python
def get_result(self, *, backend=None, block=False, timeout=None): """Get the result associated with this message from a result backend. Warning: If you use multiple result backends or brokers you should always pass the backend parameter. This method is only able t...
[ "def", "get_result", "(", "self", ",", "*", ",", "backend", "=", "None", ",", "block", "=", "False", ",", "timeout", "=", "None", ")", ":", "if", "not", "backend", ":", "broker", "=", "get_broker", "(", ")", "for", "middleware", "in", "broker", ".", ...
Get the result associated with this message from a result backend. Warning: If you use multiple result backends or brokers you should always pass the backend parameter. This method is only able to infer the result backend off of the default broker. Parameters: ...
[ "Get", "the", "result", "associated", "with", "this", "message", "from", "a", "result", "backend", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/message.py#L111-L147
train
Bogdanp/dramatiq
dramatiq/common.py
compute_backoff
def compute_backoff(attempts, *, factor=5, jitter=True, max_backoff=2000, max_exponent=32): """Compute an exponential backoff value based on some number of attempts. Parameters: attempts(int): The number of attempts there have been so far. factor(int): The number of milliseconds to multiply each ba...
python
def compute_backoff(attempts, *, factor=5, jitter=True, max_backoff=2000, max_exponent=32): """Compute an exponential backoff value based on some number of attempts. Parameters: attempts(int): The number of attempts there have been so far. factor(int): The number of milliseconds to multiply each ba...
[ "def", "compute_backoff", "(", "attempts", ",", "*", ",", "factor", "=", "5", ",", "jitter", "=", "True", ",", "max_backoff", "=", "2000", ",", "max_exponent", "=", "32", ")", ":", "exponent", "=", "min", "(", "attempts", ",", "max_exponent", ")", "bac...
Compute an exponential backoff value based on some number of attempts. Parameters: attempts(int): The number of attempts there have been so far. factor(int): The number of milliseconds to multiply each backoff by. max_backoff(int): The max number of milliseconds to backoff by. max_exponent(...
[ "Compute", "an", "exponential", "backoff", "value", "based", "on", "some", "number", "of", "attempts", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L24-L41
train
Bogdanp/dramatiq
dramatiq/common.py
join_all
def join_all(joinables, timeout): """Wait on a list of objects that can be joined with a total timeout represented by ``timeout``. Parameters: joinables(object): Objects with a join method. timeout(int): The total timeout in milliseconds. """ started, elapsed = current_millis(), 0 f...
python
def join_all(joinables, timeout): """Wait on a list of objects that can be joined with a total timeout represented by ``timeout``. Parameters: joinables(object): Objects with a join method. timeout(int): The total timeout in milliseconds. """ started, elapsed = current_millis(), 0 f...
[ "def", "join_all", "(", "joinables", ",", "timeout", ")", ":", "started", ",", "elapsed", "=", "current_millis", "(", ")", ",", "0", "for", "ob", "in", "joinables", ":", "ob", ".", "join", "(", "timeout", "=", "timeout", "/", "1000", ")", "elapsed", ...
Wait on a list of objects that can be joined with a total timeout represented by ``timeout``. Parameters: joinables(object): Objects with a join method. timeout(int): The total timeout in milliseconds.
[ "Wait", "on", "a", "list", "of", "objects", "that", "can", "be", "joined", "with", "a", "total", "timeout", "represented", "by", "timeout", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L86-L98
train
Bogdanp/dramatiq
dramatiq/common.py
dq_name
def dq_name(queue_name): """Returns the delayed queue name for a given queue. If the given queue name already belongs to a delayed queue, then it is returned unchanged. """ if queue_name.endswith(".DQ"): return queue_name if queue_name.endswith(".XQ"): queue_name = queue_name[:...
python
def dq_name(queue_name): """Returns the delayed queue name for a given queue. If the given queue name already belongs to a delayed queue, then it is returned unchanged. """ if queue_name.endswith(".DQ"): return queue_name if queue_name.endswith(".XQ"): queue_name = queue_name[:...
[ "def", "dq_name", "(", "queue_name", ")", ":", "if", "queue_name", ".", "endswith", "(", "\".DQ\"", ")", ":", "return", "queue_name", "if", "queue_name", ".", "endswith", "(", "\".XQ\"", ")", ":", "queue_name", "=", "queue_name", "[", ":", "-", "3", "]",...
Returns the delayed queue name for a given queue. If the given queue name already belongs to a delayed queue, then it is returned unchanged.
[ "Returns", "the", "delayed", "queue", "name", "for", "a", "given", "queue", ".", "If", "the", "given", "queue", "name", "already", "belongs", "to", "a", "delayed", "queue", "then", "it", "is", "returned", "unchanged", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L109-L119
train
Bogdanp/dramatiq
dramatiq/common.py
xq_name
def xq_name(queue_name): """Returns the dead letter queue name for a given queue. If the given queue name belongs to a delayed queue, the dead letter queue name for the original queue is generated. """ if queue_name.endswith(".XQ"): return queue_name if queue_name.endswith(".DQ"): ...
python
def xq_name(queue_name): """Returns the dead letter queue name for a given queue. If the given queue name belongs to a delayed queue, the dead letter queue name for the original queue is generated. """ if queue_name.endswith(".XQ"): return queue_name if queue_name.endswith(".DQ"): ...
[ "def", "xq_name", "(", "queue_name", ")", ":", "if", "queue_name", ".", "endswith", "(", "\".XQ\"", ")", ":", "return", "queue_name", "if", "queue_name", ".", "endswith", "(", "\".DQ\"", ")", ":", "queue_name", "=", "queue_name", "[", ":", "-", "3", "]",...
Returns the dead letter queue name for a given queue. If the given queue name belongs to a delayed queue, the dead letter queue name for the original queue is generated.
[ "Returns", "the", "dead", "letter", "queue", "name", "for", "a", "given", "queue", ".", "If", "the", "given", "queue", "name", "belongs", "to", "a", "delayed", "queue", "the", "dead", "letter", "queue", "name", "for", "the", "original", "queue", "is", "g...
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L122-L132
train
Bogdanp/dramatiq
dramatiq/broker.py
get_broker
def get_broker() -> "Broker": """Get the global broker instance. If no global broker is set, this initializes a RabbitmqBroker and returns it. Returns: Broker: The default Broker. """ global global_broker if global_broker is None: from .brokers.rabbitmq import RabbitmqBroker ...
python
def get_broker() -> "Broker": """Get the global broker instance. If no global broker is set, this initializes a RabbitmqBroker and returns it. Returns: Broker: The default Broker. """ global global_broker if global_broker is None: from .brokers.rabbitmq import RabbitmqBroker ...
[ "def", "get_broker", "(", ")", "->", "\"Broker\"", ":", "global", "global_broker", "if", "global_broker", "is", "None", ":", "from", ".", "brokers", ".", "rabbitmq", "import", "RabbitmqBroker", "set_broker", "(", "RabbitmqBroker", "(", "host", "=", "\"127.0.0.1\...
Get the global broker instance. If no global broker is set, this initializes a RabbitmqBroker and returns it. Returns: Broker: The default Broker.
[ "Get", "the", "global", "broker", "instance", ".", "If", "no", "global", "broker", "is", "set", "this", "initializes", "a", "RabbitmqBroker", "and", "returns", "it", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/broker.py#L26-L44
train
Bogdanp/dramatiq
dramatiq/broker.py
Broker.add_middleware
def add_middleware(self, middleware, *, before=None, after=None): """Add a middleware object to this broker. The middleware is appended to the end of the middleware list by default. You can specify another middleware (by class) as a reference point for where the new middleware should b...
python
def add_middleware(self, middleware, *, before=None, after=None): """Add a middleware object to this broker. The middleware is appended to the end of the middleware list by default. You can specify another middleware (by class) as a reference point for where the new middleware should b...
[ "def", "add_middleware", "(", "self", ",", "middleware", ",", "*", ",", "before", "=", "None", ",", "after", "=", "None", ")", ":", "assert", "not", "(", "before", "and", "after", ")", ",", "\"provide either 'before' or 'after', but not both\"", "if", "before"...
Add a middleware object to this broker. The middleware is appended to the end of the middleware list by default. You can specify another middleware (by class) as a reference point for where the new middleware should be added. Parameters: middleware(Middleware): The middlewar...
[ "Add", "a", "middleware", "object", "to", "this", "broker", ".", "The", "middleware", "is", "appended", "to", "the", "end", "of", "the", "middleware", "list", "by", "default", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/broker.py#L102-L144
train
Bogdanp/dramatiq
dramatiq/broker.py
Broker.declare_actor
def declare_actor(self, actor): # pragma: no cover """Declare a new actor on this broker. Declaring an Actor twice replaces the first actor with the second by name. Parameters: actor(Actor): The actor being declared. """ self.emit_before("declare_actor", actor) ...
python
def declare_actor(self, actor): # pragma: no cover """Declare a new actor on this broker. Declaring an Actor twice replaces the first actor with the second by name. Parameters: actor(Actor): The actor being declared. """ self.emit_before("declare_actor", actor) ...
[ "def", "declare_actor", "(", "self", ",", "actor", ")", ":", "# pragma: no cover", "self", ".", "emit_before", "(", "\"declare_actor\"", ",", "actor", ")", "self", ".", "declare_queue", "(", "actor", ".", "queue_name", ")", "self", ".", "actors", "[", "actor...
Declare a new actor on this broker. Declaring an Actor twice replaces the first actor with the second by name. Parameters: actor(Actor): The actor being declared.
[ "Declare", "a", "new", "actor", "on", "this", "broker", ".", "Declaring", "an", "Actor", "twice", "replaces", "the", "first", "actor", "with", "the", "second", "by", "name", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/broker.py#L166-L176
train
Bogdanp/dramatiq
dramatiq/brokers/rabbitmq.py
URLRabbitmqBroker
def URLRabbitmqBroker(url, *, middleware=None): """Alias for the RabbitMQ broker that takes a connection URL as a positional argument. Parameters: url(str): A connection string. middleware(list[Middleware]): The middleware to add to this broker. """ warnings.warn( "Use R...
python
def URLRabbitmqBroker(url, *, middleware=None): """Alias for the RabbitMQ broker that takes a connection URL as a positional argument. Parameters: url(str): A connection string. middleware(list[Middleware]): The middleware to add to this broker. """ warnings.warn( "Use R...
[ "def", "URLRabbitmqBroker", "(", "url", ",", "*", ",", "middleware", "=", "None", ")", ":", "warnings", ".", "warn", "(", "\"Use RabbitmqBroker with the 'url' parameter instead of URLRabbitmqBroker.\"", ",", "DeprecationWarning", ",", "stacklevel", "=", "2", ",", ")",...
Alias for the RabbitMQ broker that takes a connection URL as a positional argument. Parameters: url(str): A connection string. middleware(list[Middleware]): The middleware to add to this broker.
[ "Alias", "for", "the", "RabbitMQ", "broker", "that", "takes", "a", "connection", "URL", "as", "a", "positional", "argument", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L387-L400
train
Bogdanp/dramatiq
dramatiq/brokers/rabbitmq.py
RabbitmqBroker.close
def close(self): """Close all open RabbitMQ connections. """ # The main thread may keep connections open for a long time # w/o publishing heartbeats, which means that they'll end up # being closed by the time the broker is closed. When that # happens, pika logs a bunch o...
python
def close(self): """Close all open RabbitMQ connections. """ # The main thread may keep connections open for a long time # w/o publishing heartbeats, which means that they'll end up # being closed by the time the broker is closed. When that # happens, pika logs a bunch o...
[ "def", "close", "(", "self", ")", ":", "# The main thread may keep connections open for a long time", "# w/o publishing heartbeats, which means that they'll end up", "# being closed by the time the broker is closed. When that", "# happens, pika logs a bunch of scary stuff so we want to", "# fil...
Close all open RabbitMQ connections.
[ "Close", "all", "open", "RabbitMQ", "connections", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L147-L168
train
Bogdanp/dramatiq
dramatiq/brokers/rabbitmq.py
RabbitmqBroker.declare_queue
def declare_queue(self, queue_name): """Declare a queue. Has no effect if a queue with the given name already exists. Parameters: queue_name(str): The name of the new queue. Raises: ConnectionClosed: If the underlying channel or connection has been clos...
python
def declare_queue(self, queue_name): """Declare a queue. Has no effect if a queue with the given name already exists. Parameters: queue_name(str): The name of the new queue. Raises: ConnectionClosed: If the underlying channel or connection has been clos...
[ "def", "declare_queue", "(", "self", ",", "queue_name", ")", ":", "attempts", "=", "1", "while", "True", ":", "try", ":", "if", "queue_name", "not", "in", "self", ".", "queues", ":", "self", ".", "emit_before", "(", "\"declare_queue\"", ",", "queue_name", ...
Declare a queue. Has no effect if a queue with the given name already exists. Parameters: queue_name(str): The name of the new queue. Raises: ConnectionClosed: If the underlying channel or connection has been closed.
[ "Declare", "a", "queue", ".", "Has", "no", "effect", "if", "a", "queue", "with", "the", "given", "name", "already", "exists", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L183-L224
train
Bogdanp/dramatiq
dramatiq/brokers/rabbitmq.py
RabbitmqBroker.get_queue_message_counts
def get_queue_message_counts(self, queue_name): """Get the number of messages in a queue. This method is only meant to be used in unit and integration tests. Parameters: queue_name(str): The queue whose message counts to get. Returns: tuple: A triple representing t...
python
def get_queue_message_counts(self, queue_name): """Get the number of messages in a queue. This method is only meant to be used in unit and integration tests. Parameters: queue_name(str): The queue whose message counts to get. Returns: tuple: A triple representing t...
[ "def", "get_queue_message_counts", "(", "self", ",", "queue_name", ")", ":", "queue_response", "=", "self", ".", "_declare_queue", "(", "queue_name", ")", "dq_queue_response", "=", "self", ".", "_declare_dq_queue", "(", "queue_name", ")", "xq_queue_response", "=", ...
Get the number of messages in a queue. This method is only meant to be used in unit and integration tests. Parameters: queue_name(str): The queue whose message counts to get. Returns: tuple: A triple representing the number of messages in the queue, its delayed q...
[ "Get", "the", "number", "of", "messages", "in", "a", "queue", ".", "This", "method", "is", "only", "meant", "to", "be", "used", "in", "unit", "and", "integration", "tests", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L318-L336
train
Bogdanp/dramatiq
dramatiq/rate_limits/barrier.py
Barrier.create
def create(self, parties): """Create the barrier for the given number of parties. Parameters: parties(int): The number of parties to wait for. Returns: bool: Whether or not the new barrier was successfully created. """ assert parties > 0, "parties must be a ...
python
def create(self, parties): """Create the barrier for the given number of parties. Parameters: parties(int): The number of parties to wait for. Returns: bool: Whether or not the new barrier was successfully created. """ assert parties > 0, "parties must be a ...
[ "def", "create", "(", "self", ",", "parties", ")", ":", "assert", "parties", ">", "0", ",", "\"parties must be a positive integer.\"", "return", "self", ".", "backend", ".", "add", "(", "self", ".", "key", ",", "parties", ",", "self", ".", "ttl", ")" ]
Create the barrier for the given number of parties. Parameters: parties(int): The number of parties to wait for. Returns: bool: Whether or not the new barrier was successfully created.
[ "Create", "the", "barrier", "for", "the", "given", "number", "of", "parties", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/rate_limits/barrier.py#L50-L60
train
Bogdanp/dramatiq
dramatiq/rate_limits/barrier.py
Barrier.wait
def wait(self, *, block=True, timeout=None): """Signal that a party has reached the barrier. Warning: Barrier blocking is currently only supported by the stub and Redis backends. Warning: Re-using keys between blocking calls may lead to undefined behavio...
python
def wait(self, *, block=True, timeout=None): """Signal that a party has reached the barrier. Warning: Barrier blocking is currently only supported by the stub and Redis backends. Warning: Re-using keys between blocking calls may lead to undefined behavio...
[ "def", "wait", "(", "self", ",", "*", ",", "block", "=", "True", ",", "timeout", "=", "None", ")", ":", "cleared", "=", "not", "self", ".", "backend", ".", "decr", "(", "self", ".", "key", ",", "1", ",", "1", ",", "self", ".", "ttl", ")", "if...
Signal that a party has reached the barrier. Warning: Barrier blocking is currently only supported by the stub and Redis backends. Warning: Re-using keys between blocking calls may lead to undefined behaviour. Make sure your barrier keys are always unique ...
[ "Signal", "that", "a", "party", "has", "reached", "the", "barrier", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/rate_limits/barrier.py#L62-L91
train
Bogdanp/dramatiq
dramatiq/middleware/threading.py
raise_thread_exception
def raise_thread_exception(thread_id, exception): """Raise an exception in a thread. Currently, this is only available on CPython. Note: This works by setting an async exception in the thread. This means that the exception will only get called the next time that thread acquires the GIL....
python
def raise_thread_exception(thread_id, exception): """Raise an exception in a thread. Currently, this is only available on CPython. Note: This works by setting an async exception in the thread. This means that the exception will only get called the next time that thread acquires the GIL....
[ "def", "raise_thread_exception", "(", "thread_id", ",", "exception", ")", ":", "if", "current_platform", "==", "\"CPython\"", ":", "_raise_thread_exception_cpython", "(", "thread_id", ",", "exception", ")", "else", ":", "message", "=", "\"Setting thread exceptions (%s) ...
Raise an exception in a thread. Currently, this is only available on CPython. Note: This works by setting an async exception in the thread. This means that the exception will only get called the next time that thread acquires the GIL. Concretely, this means that this middleware can't ...
[ "Raise", "an", "exception", "in", "a", "thread", "." ]
a8cc2728478e794952a5a50c3fb19ec455fe91b6
https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/middleware/threading.py#L43-L59
train