uploaded readme

README.md

@@ -0,0 +1,338 @@
+Quantization made by Richard Erkhov.
+
+[Github](https://github.com/RichardErkhov)
+
+[Discord](https://discord.gg/pvy7H8DZMG)
+
+[Request more models](https://github.com/RichardErkhov/quant_request)
+
+
+bigbird-pegasus-large-K-booksum - bnb 4bits
+- Model creator: https://huggingface.co/pszemraj/
+- Original model: https://huggingface.co/pszemraj/bigbird-pegasus-large-K-booksum/
+
+
+
+
+Original model description:
+---
+language:
+- en
+license: apache-2.0
+tags:
+- summarization
+- summarisation
+- summary
+- notes
+- bigbird_pegasus_
+- pegasus
+- bigbird
+datasets:
+- kmfoda/booksum
+metrics:
+- rouge
+widget:
+- text: large earthquakes along a given fault segment do not occur at random intervals
+    because it takes time to accumulate the strain energy for the rupture. The rates
+    at which tectonic plates move and accumulate strain at their boundaries are approximately
+    uniform. Therefore, in first approximation, one may expect that large ruptures
+    of the same fault segment will occur at approximately constant time intervals.
+    If subsequent main shocks have different amounts of slip across the fault, then
+    the recurrence time may vary, and the basic idea of periodic mainshocks must be
+    modified. For great plate boundary ruptures the length and slip often vary by
+    a factor of 2. Along the southern segment of the San Andreas fault the recurrence
+    interval is 145 years with variations of several decades. The smaller the standard
+    deviation of the average recurrence interval, the more specific could be the long
+    term prediction of a future mainshock.
+  example_title: earthquakes
+- text: ' A typical feed-forward neural field algorithm. Spatiotemporal coordinates
+    are fed into a neural network that predicts values in the reconstructed domain.
+    Then, this domain is mapped to the sensor domain where sensor measurements are
+    available as supervision. Class and Section Problems Addressed Generalization
+    (Section 2) Inverse problems, ill-posed problems, editability; symmetries. Hybrid
+    Representations (Section 3) Computation & memory efficiency, representation capacity,
+    editability: Forward Maps (Section 4) Inverse problems Network Architecture (Section
+    5) Spectral bias, integration & derivatives. Manipulating Neural Fields (Section
+    6) Edit ability, constraints, regularization. Table 2: The five classes of techniques
+    in the neural field toolbox each addresses problems that arise in learning, inference,
+    and control. (Section 3). We can supervise reconstruction via differentiable forward
+    maps that transform Or project our domain (e.g, 3D reconstruction via 2D images;
+    Section 4) With appropriate network architecture choices, we can overcome neural
+    network spectral biases (blurriness) and efficiently compute derivatives and integrals
+    (Section 5). Finally, we can manipulate neural fields to add constraints and regularizations,
+    and to achieve editable representations (Section 6). Collectively, these classes
+    constitute a ''toolbox'' of techniques to help solve problems with neural fields
+    There are three components in a conditional neural field: (1) An encoder or inference
+    function € that outputs the conditioning latent variable 2 given an observation
+    0 E(0) =2. 2 is typically a low-dimensional vector, and is often referred to aS
+    a latent code Or feature code_ (2) A mapping function 4 between Z and neural field
+    parameters O: Y(z) = O; (3) The neural field itself $. The encoder € finds the
+    most probable z given the observations O: argmaxz P(2/0). The decoder maximizes
+    the inverse conditional probability to find the most probable 0 given Z: arg-
+    max P(Olz). We discuss different encoding schemes with different optimality guarantees
+    (Section 2.1.1), both global and local conditioning (Section 2.1.2), and different
+    mapping functions Y (Section 2.1.3) 2. Generalization Suppose we wish to estimate
+    a plausible 3D surface shape given a partial or noisy point cloud. We need a suitable
+    prior over the sur- face in its reconstruction domain to generalize to the partial
+    observations. A neural network expresses a prior via the function space of its
+    architecture and parameters 0, and generalization is influenced by the inductive
+    bias of this function space (Section 5).'
+  example_title: scientific paper
+- text: ' the big variety of data coming from diverse sources is one of the key properties
+    of the big data phenomenon. It is, therefore, beneficial to understand how data
+    is generated in various environments and scenarios, before looking at what should
+    be done with this data and how to design the best possible architecture to accomplish
+    this The evolution of IT architectures, described in Chapter 2, means that the
+    data is no longer processed by a few big monolith systems, but rather by a group
+    of services In parallel to the processing layer, the underlying data storage has
+    also changed and became more distributed This, in turn, required a significant
+    paradigm shift as the traditional approach to transactions (ACID) could no longer
+    be supported. On top of this, cloud computing is becoming a major approach with
+    the benefits of reducing costs and providing on-demand scalability but at the
+    same time introducing concerns about privacy, data ownership, etc In the meantime
+    the Internet continues its exponential growth: Every day both structured and unstructured
+    data is published and available for processing: To achieve competitive advantage
+    companies have to relate their corporate resources to external services, e.g.
+    financial markets, weather forecasts, social media, etc While several of the sites
+    provide some sort of API to access the data in a more orderly fashion; countless
+    sources require advanced web mining and Natural Language Processing (NLP) processing
+    techniques: Advances in science push researchers to construct new instruments
+    for observing the universe O conducting experiments to understand even better
+    the laws of physics and other domains. Every year humans have at their disposal
+    new telescopes, space probes, particle accelerators, etc These instruments generate
+    huge streams of data, which need to be stored and analyzed. The constant drive
+    for efficiency in the industry motivates the introduction of new automation techniques
+    and process optimization: This could not be done without analyzing the precise
+    data that describe these processes. As more and more human tasks are automated,
+    machines provide rich data sets, which can be analyzed in real-time to drive efficiency
+    to new levels. Finally, it is now evident that the growth of the Internet of Things
+    is becoming a major source of data. More and more of the devices are equipped
+    with significant computational power and can generate a continuous data stream
+    from their sensors. In the subsequent sections of this chapter, we will look at
+    the domains described above to see what they generate in terms of data sets. We
+    will compare the volumes but will also look at what is characteristic and important
+    from their respective points of view. 3.1 The Internet is undoubtedly the largest
+    database ever created by humans. While several well described; cleaned, and structured
+    data sets have been made available through this medium, most of the resources
+    are of an ambiguous, unstructured, incomplete or even erroneous nature. Still,
+    several examples in the areas such as opinion mining, social media analysis, e-governance,
+    etc, clearly show the potential lying in these resources. Those who can successfully
+    mine and interpret the Internet data can gain unique insight and competitive advantage
+    in their business An important area of data analytics on the edge of corporate
+    IT and the Internet is Web Analytics.'
+  example_title: data science textbook
+- text: 'Transformer-based models have shown to be very useful for many NLP tasks.
+    However, a major limitation of transformers-based models is its O(n^2)O(n 2) time
+    & memory complexity (where nn is sequence length). Hence, it''s computationally
+    very expensive to apply transformer-based models on long sequences n > 512n>512.
+    Several recent papers, e.g. Longformer, Performer, Reformer, Clustered attention
+    try to remedy this problem by approximating the full attention matrix. You can
+    checkout 🤗''s recent blog post in case you are unfamiliar with these models.
+
+    BigBird (introduced in paper) is one of such recent models to address this issue.
+    BigBird relies on block sparse attention instead of normal attention (i.e. BERT''s
+    attention) and can handle sequences up to a length of 4096 at a much lower computational
+    cost compared to BERT. It has achieved SOTA on various tasks involving very long
+    sequences such as long documents summarization, question-answering with long contexts.
+
+    BigBird RoBERTa-like model is now available in 🤗Transformers. The goal of this
+    post is to give the reader an in-depth understanding of big bird implementation
+    & ease one''s life in using BigBird with 🤗Transformers. But, before going into
+    more depth, it is important to remember that the BigBird''s attention is an approximation
+    of BERT''s full attention and therefore does not strive to be better than BERT''s
+    full attention, but rather to be more efficient. It simply allows to apply transformer-based
+    models to much longer sequences since BERT''s quadratic memory requirement quickly
+    becomes unbearable. Simply put, if we would have ∞ compute & ∞ time, BERT''s attention
+    would be preferred over block sparse attention (which we are going to discuss
+    in this post).
+
+    If you wonder why we need more compute when working with longer sequences, this
+    blog post is just right for you!
+
+    Some of the main questions one might have when working with standard BERT-like
+    attention include:
+
+    Do all tokens really have to attend to all other tokens? Why not compute attention
+    only over important tokens? How to decide what tokens are important? How to attend
+    to just a few tokens in a very efficient way? In this blog post, we will try to
+    answer those questions.
+
+    What tokens should be attended to? We will give a practical example of how attention
+    works by considering the sentence ''BigBird is now available in HuggingFace for
+    extractive question answering''. In BERT-like attention, every word would simply
+    attend to all other tokens.
+
+    Let''s think about a sensible choice of key tokens that a queried token actually
+    only should attend to by writing some pseudo-code. Will will assume that the token
+    available is queried and build a sensible list of key tokens to attend to.
+
+    >>> # let''s consider following sentence as an example >>> example = [''BigBird'',
+    ''is'', ''now'', ''available'', ''in'', ''HuggingFace'', ''for'', ''extractive'',
+    ''question'', ''answering'']
+
+    >>> # further let''s assume, we''re trying to understand the representation of
+    ''available'' i.e. >>> query_token = ''available'' >>> # We will initialize an
+    empty `set` and fill up the tokens of our interest as we proceed in this section.
+    >>> key_tokens = [] # => currently ''available'' token doesn''t have anything
+    to attend Nearby tokens should be important because, in a sentence (sequence of
+    words), the current word is highly dependent on neighboring past & future tokens.
+    This intuition is the idea behind the concept of sliding attention.'
+  example_title: bigbird blog intro
+inference:
+  parameters:
+    max_length: 64
+    no_repeat_ngram_size: 2
+    encoder_no_repeat_ngram_size: 3
+    repetition_penalty: 2.4
+    length_penalty: 0.5
+    num_beams: 4
+    early_stopping: true
+model-index:
+- name: pszemraj/bigbird-pegasus-large-K-booksum
+  results:
+  - task:
+      type: summarization
+      name: Summarization
+    dataset:
+      name: kmfoda/booksum
+      type: kmfoda/booksum
+      config: kmfoda--booksum
+      split: test
+    metrics:
+    - type: rouge
+      value: 34.0757
+      name: ROUGE-1
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiYzk3NmI2ODg0MDM3MzY3ZjMyYzhmNTYyZjBmNTJlM2M3MjZjMzI0YzMxNmRmODhhMzI2MDMzMzMzMmJhMGIyMCIsInZlcnNpb24iOjF9.gM1ClaQdlrDE9q3CGF164WhhlTpg8Ym1cpvN1RARK8FGKDSR37EWmgdg-PSSHgB_l9NuvZ3BgoC7hKxfpcnKCQ
+    - type: rouge
+      value: 5.9177
+      name: ROUGE-2
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiMzdmMGU5ODhiMjcxZTJjODk3ZWI3NjY0NWJkMDFjYWI1ZDIyN2YwMDBjODE2ODQzY2I4ZTA1NWI0MTZiZGQwYSIsInZlcnNpb24iOjF9.ZkX-5RfN9cR1y56TUJWFtMRkHRRIzh9bEApa08ClR1ybgHvsnTjhSnNaNSjpXBR4jOVV9075qV38MJpqO8U8Bg
+    - type: rouge
+      value: 16.3874
+      name: ROUGE-L
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiMWU4ODExMjEwZjcyOWQ3NGJkYzM4NDgyMGQ2YzM5OThkNWIyMmVhMDNkNjA5OGRkM2UyMDE1MGIxZGVhMjUzZSIsInZlcnNpb24iOjF9.2pDo80GWdIAeyWZ4js7PAf_tJCsRceZTX0MoBINGsdjFBI864C1MkgB1s8aJx5Q47oZMkeFoFoAu0Vs21KF4Cg
+    - type: rouge
+      value: 31.6118
+      name: ROUGE-LSUM
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiYjY2ODJiZDg2MzI3N2M5NTU5YzIyZmQ0NzkwM2NlY2U0ZDQ5OTM0NmM5ZmI5NjUxYjA3N2IwYWViOTkxN2MxZCIsInZlcnNpb24iOjF9.9c6Spmci31HdkfXUqKyju1X-Z9HOHSSnZNgC4JDyN6csLaDWkyVwWs5xWvC0mvEnaEnigmkSX1Uy3i355ELmBw
+    - type: loss
+      value: 3.522040605545044
+      name: loss
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiODAyZTFiMjUzYTIzNWI0YjQxOWNlZjdkYjcxNDY3ZjMyNTg3ZDdkOTg3YmEzMjFiYzk2NTM4ZTExZjJiZmI3MCIsInZlcnNpb24iOjF9.n-L_DOkTlkbipJWIQQA-cQqeWJ9Q_b1d2zm7RhLxSpjzXegFxJgkC25hTEhqvanGYZwzahn950ikyyxa4JevAw
+    - type: gen_len
+      value: 254.3676
+      name: gen_len
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiMzdlY2U1ZTgwNGUyNGM4ZGJlNDNlY2RjOWViYmFkOWE0ZjMzYTU0ZTg2NTlkN2EyMTYyMjE0NjcwOTU4NzY2NiIsInZlcnNpb24iOjF9.YnwkkcCRnZWbh48BX0fktufQk5pb0qfQvjNrIbARYx7w0PTd-6Fjn6FKwCJ1MOfyeZDI1sd6xckm_Wt8XsReAg
+  - task:
+      type: summarization
+      name: Summarization
+    dataset:
+      name: launch/gov_report
+      type: launch/gov_report
+      config: plain_text
+      split: test
+    metrics:
+    - type: rouge
+      value: 40.015
+      name: ROUGE-1
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiMzE1MGM3ZDYzMDgwZGRlZDRkYmFmZGI4ODg0N2NhMGUyYmU1YmI5Njg0MzMxNzAxZGUxYjc3NTZjYjMwZDhmOCIsInZlcnNpb24iOjF9.7-SojdX5JiNAK31FpAHfkic0S2iziZiYWHCTnb4VTjsDnrDP3xfow1BWsC1N9aNAN_Pi-7FDh_BhDMp89csoCQ
+    - type: rouge
+      value: 10.7406
+      name: ROUGE-2
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiZjEwOTRjOTA4N2E0OGQ3OGY0OThjNjlkN2VlZDBlNTI4OGYxNDFiN2YxYTI2YjBjOTJhYWJiNGE1NzcyOWE5YyIsInZlcnNpb24iOjF9.SrMCtxOkMabMELFr5_yqG52zTKGk81oqnqczrovgsko1bGhqpR-83nE7dc8oZ_tmTsbTUF3i7cQ3Eb_8EvPhDg
+    - type: rouge
+      value: 20.1344
+      name: ROUGE-L
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiYzkxZmJkYzdmOGI3Yzc1ZDliNGY3ZjE5OWFiYmFmMTU4ZWU2ZDUyNzE0YmY3MmUyMTQyNjkyMTMwYTM2OWU2ZSIsInZlcnNpb24iOjF9.FPX3HynlHurNYlgK1jjocJHZIZ2t8OLFS_qN8skIwbzw1mGb8ST3tVebE9qeXZWY9TbNfWsGERShJH1giw2qDw
+    - type: rouge
+      value: 36.7743
+      name: ROUGE-LSUM
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiYjgxNmQ1MmEwY2VlYTAzMTVhMDBlODFjMDNlMjA4NjRiOTNkNjkxZWNiNDg4ODM1NWUwNjk1ODFkMzI3YmM5ZCIsInZlcnNpb24iOjF9.uK7C2bGmOGEWzc8D2Av_WYSqn2epqqiXXq2ybJmoHAT8GYc80jpEGTKjyhjf00lCLw-kOxeSG5Qpr_JihR5kAg
+    - type: loss
+      value: 3.8273396492004395
+      name: loss
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiNzI4OTcwOGYzYmM5MmM2NmViNjc4MTkyYzJlYjAwODM4ODRmZTAyZTVmMjJlY2JiYjY0YjA5OWY4NDhjOWQ0ZiIsInZlcnNpb24iOjF9.p46FdAgmW5t3KtP4kBhcoVynTQJj1abV4LqM6MQ-o--c46yMlafmtA4mgMEqsJK_CZl7Iv5SSP_n8GiVMpgmAQ
+    - type: gen_len
+      value: 228.1285
+      name: gen_len
+      verified: true
+      verifyToken: eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJoYXNoIjoiODY2OGUzNDlhNzM5NzBiMmNmMDZiNjNkNDI0MDkxMzNkZDE4ZjU4OWM1NGQ5Yjk3ZjgzZjk2MDk0NWI0NGI4YiIsInZlcnNpb24iOjF9.Jb61P9-a31VBbwdOD-8ahNgf5Tpln0vjxd4uQtR7vxGu0Ovfa1T9Y8rKXBApTSigrmqBjRdsLfoAU7LqLiL6Cg
+---
+
+
+# bigbird pegasus on the booksum dataset 
+
+>_this is the "latest" version of the model that has been trained the longest, currently at 70k steps_
+
+- **GOAL:** A summarization model that 1) summarizes the source content accurately 2) _more important IMO_ produces summaries that are easy to read and understand (* cough * unlike arXiv * cough *)
+  - This model attempts to help with that by using the [booksum](https://arxiv.org/abs/2105.08209) dataset to provide **explanatory summarization**
+  - Explanatory Summary - A summary that both consolidates information and also explains why said consolidated information is important.
+- This model was trained for seven epochs total (approx 70,000 steps) and is closer to finished.
+  - Will continue to improve  (slowly, now that it has been trained for a long time) based on any result findings/feedback.
+- starting checkpoint was `google/bigbird-pegasus-large-bigpatent`
+
+---
+
+# example usage
+
+> An extended example, including a demo of batch summarization, is [here](https://colab.research.google.com/gist/pszemraj/2c8c0aecbcd4af6e9cbb51e195be10e2/bigbird-pegasus-large-booksum-20k-example.ipynb).
+
+
+- create the summarizer object:
+
+```python
+from transformers import AutoModelForSeq2SeqLM, AutoTokenizer
+from transformers import pipeline
+
+model = AutoModelForSeq2SeqLM.from_pretrained(
+    "pszemraj/bigbird-pegasus-large-K-booksum",
+    low_cpu_mem_usage=True,
+)
+
+tokenizer = AutoTokenizer.from_pretrained(
+    "pszemraj/bigbird-pegasus-large-K-booksum",
+)
+
+
+summarizer = pipeline(
+    "summarization",
+    model=model,
+    tokenizer=tokenizer,
+)          
+ ```
+
+- define text to be summarized, and pass it through the pipeline. Boom done. 
+
+```python
+wall_of_text = "your text to be summarized goes here."
+
+result = summarizer(
+    wall_of_text,
+    min_length=16,
+    max_length=256,
+    no_repeat_ngram_size=3,
+    clean_up_tokenization_spaces=True,
+)
+
+print(result[0]["summary_text"])
+```
+
+## Alternate Checkpoint
+
+- if experiencing runtime/memory issues, try [this earlier checkpoint](https://huggingface.co/pszemraj/bigbird-pegasus-large-booksum-40k-K) at 40,000 steps which is almost as good at the explanatory summarization task but runs faster.
+- see similar summarization models fine-tuned on booksum but using different architectures: [long-t5 base](https://huggingface.co/pszemraj/long-t5-tglobal-base-16384-book-summary) and [LED-Large](https://huggingface.co/pszemraj/led-large-book-summary)
+
+---
+
+