qreflex 0.0.1__tar.gz

qreflex-0.0.1/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Qarvexium
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qreflex-0.0.1/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: qreflex
+Version: 0.0.1
+Summary: QreFLEX (reFLEX) — a small transformer with a gated, trainable experience-retrieval side channel: reason first, consult learned experience when useful, reason again.
+Author: Qarvexium
+License: Apache-2.0
+Project-URL: Homepage, https://qarvexium-ops.github.io/Qs/index.html
+Project-URL: Repository, https://huggingface.co/qvx-o
+Keywords: transformer,language-model,retrieval-augmented-generation,experience-replay,reflex
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.1
+Requires-Dist: tokenizers>=0.15
+Requires-Dist: fastapi>=0.100
+Requires-Dist: uvicorn>=0.23
+Requires-Dist: pydantic>=2.0
+Requires-Dist: huggingface_hub>=0.20
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: httpx>=0.24; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Dynamic: license-file
+
+# reFLEX-v1-15M
+
+**reFLEX** — *Responsive Flexible Learning and EXperience* — is a small experimental conversational language model designed around a different idea from a conventional "everything is attention" transformer.
+
+Rather than relying entirely on the main language model to produce a response, reFLEX separates parts of the conversational process into three components:
+
+* **Main** — the primary language-generation network.
+* **Experience** — a lightweight retrieval/context component that can surface potentially useful information from previous experience.
+* **Intent** — a small component intended to help interpret the nature of the input.
+
+The result is a roughly **15M-parameter** model with an unusual parameter distribution:
+
+| Component  | Parameters |
+| ---------- | ---------: |
+| Main       |       ~14M |
+| Experience |      ~0.8M |
+| Intent     |      ~0.2M |
+| **Total**  |   **~15M** |
+
+## What is reFLEX?
+
+reFLEX is primarily an **experimental conversational model**, not a factual knowledge model.
+
+It was trained on conversational-style data rather than a large factual corpus. Consequently, it should **not** be expected to reliably answer factual questions such as:
+
+> What is the capital of France?
+
+Its interesting behavior appears much more clearly in ordinary conversation.
+
+For example:
+
+```text
+A: Hello
+B: Hello
+
+A: How are you?
+B: Fine.
+
+A: What's up?
+B: Not much. Just hanging out.
+```
+
+The model can produce surprisingly conversational responses despite its very small parameter count.
+
+## Architecture
+
+reFLEX moves away from the idea that every part of the system needs to be represented by a large attention-based language model.
+
+Its conceptual structure is:
+
+```text
+                 Input
+                   │
+                   ▼
+              ┌─────────┐
+              │ Intent  │
+              └────┬────┘
+                   │
+                   ▼
+              ┌─────────┐
+              │Experience│
+              └────┬────┘
+                   │
+                   ▼
+              ┌─────────┐
+              │  Main   │
+              │  Model  │
+              └────┬────┘
+                   │
+                   ▼
+                Response
+```
+
+The **Experience** component can be thought of as a lightweight helper that effectively says:
+
+> "These topics or pieces of information might be useful here."
+
+It is not intended to replace the main language model.
+
+## Parameter Distribution
+
+One of the notable properties of reFLEX-v1-15M is that the total parameter count is not divided evenly between its components.
+
+Approximately:
+
+* **Main:** 14M parameters
+* **Experience:** 0.8M parameters
+* **Intent:** 0.2M parameters
+
+This means the majority of the model's capacity remains dedicated to language generation, while relatively small components provide additional processing.
+
+## Intended Use
+
+reFLEX-v1-15M is intended for:
+
+* Experimental conversational AI
+* Research into modular language-model architectures
+* Studying small language models
+* Exploring retrieval/experience-assisted generation
+* Conversational behavior experiments
+* Educational experimentation with transformer architectures
+
+## Limitations
+
+reFLEX-v1-15M is **not** a general-purpose assistant.
+
+It has several important limitations:
+
+* It has very limited factual knowledge.
+* It can hallucinate heavily.
+* Responses may be grammatically incorrect or semantically unrelated.
+* It may produce abrupt or unusual responses.
+* It may repeat itself.
+* It may exhibit inconsistent conversational behavior.
+* Its responses can vary substantially between generations.
+* It was not trained to follow instructions reliably.
+* It should not be used for factual, medical, legal, financial, or safety-critical applications.
+
+The model's unusual conversational personality should be considered an **emergent property of the training and architecture**, not an indication of human-like understanding.
+
+## Conversational Behavior
+
+An interesting characteristic observed during testing is that reFLEX sometimes reacts differently depending on the **social tone** of an input.
+
+Informal testing produced behavior roughly resembling:
+
+| Input style | Observed behavior                  |
+| ----------- | ---------------------------------- |
+| Positive    | Dramatic / enthusiastic            |
+| Neutral     | Introverted / brief                |
+| Negative    | Defensive / sarcastic              |
+| Confusing   | Uncertain / existential            |
+| Commands    | Occasionally resistant or confused |
+
+These behaviors are **observations from experimentation, not guaranteed capabilities**.
+
+For example:
+
+```text
+A: You're pretty cool.
+B: No.
+```
+
+and:
+
+```text
+A: I appreciate the effort.
+B: You're an idiot.
+```
+
+The model can also produce unexpectedly ordinary conversational responses:
+
+```text
+A: What's up?
+B: Just got back from the park with my dog.
+```
+
+This makes reFLEX particularly interesting as a research experiment despite its extremely small size.
+
+## Experience Ablation
+
+Testing with and without the Experience component showed that Experience can substantially alter the generated response.
+
+However, because the model was not trained specifically as a factual QA system, activating Experience does **not** guarantee factual correctness.
+
+For this reason, Experience should be understood as a mechanism for influencing generation through contextual information rather than as a conventional knowledge database.
+
+## Generation
+
+A basic example using the `qreflex` package:
+
+```python
+from qreflex import reFLEX
+
+model = reFLEX(
+    directory=r"D:\QED\REFLEX\flex", # Or repo: qvx-o/reFLEX-v1-15M
+    from_pretrained=True, # if repo dont use
+    checkpoint_file=r"D:\QED\REFLEX\flex\reFLEX-v1-15M.pt", # if rpeo dont use
+)
+
+question = "What's up?"
+
+answer = model.generate(
+    f"A: {question}\nB:",
+    use_experience=True,
+    stop=["\nA: ", "\nB:"]
+)
+
+print(f"A: {question}\nB:", answer)
+```
+
+## Benchmarking
+
+A conversational benchmark was created specifically for reFLEX-v1-15M.
+
+The benchmark contains examples covering several conversational categories, including:
+
+* Greetings
+* Casual conversation
+* Positive statements
+* Affection
+* Commands
+* Negative statements
+* Criticism
+* Confusing inputs
+
+The benchmark is intended primarily to demonstrate **behavioral characteristics**, rather than conventional language-model performance.
+
+## Important Note
+
+reFLEX-v1-15M is intentionally small.
+
+Its purpose is not to demonstrate that a 15M model can compete with large language models on factual knowledge or general reasoning.
+
+Instead, reFLEX explores a different question:
+
+> **How much conversational behavior can emerge from a very small language model when some responsibilities are moved outside the main language generator?**
+
+The model is experimental, imperfect, and occasionally bizarre — but that is part of what makes it interesting.
+
+## Disclaimer
+
+**reFLEX-v1-15M is an experimental conversational model.**
+
+It may produce unexpected, sarcastic, dramatic, nonsensical, or otherwise strange responses. Do not interpret its outputs as authoritative information.

qreflex-0.0.1/README.md

@@ -0,0 +1,225 @@
+# reFLEX-v1-15M
+
+**reFLEX** — *Responsive Flexible Learning and EXperience* — is a small experimental conversational language model designed around a different idea from a conventional "everything is attention" transformer.
+
+Rather than relying entirely on the main language model to produce a response, reFLEX separates parts of the conversational process into three components:
+
+* **Main** — the primary language-generation network.
+* **Experience** — a lightweight retrieval/context component that can surface potentially useful information from previous experience.
+* **Intent** — a small component intended to help interpret the nature of the input.
+
+The result is a roughly **15M-parameter** model with an unusual parameter distribution:
+
+| Component  | Parameters |
+| ---------- | ---------: |
+| Main       |       ~14M |
+| Experience |      ~0.8M |
+| Intent     |      ~0.2M |
+| **Total**  |   **~15M** |
+
+## What is reFLEX?
+
+reFLEX is primarily an **experimental conversational model**, not a factual knowledge model.
+
+It was trained on conversational-style data rather than a large factual corpus. Consequently, it should **not** be expected to reliably answer factual questions such as:
+
+> What is the capital of France?
+
+Its interesting behavior appears much more clearly in ordinary conversation.
+
+For example:
+
+```text
+A: Hello
+B: Hello
+
+A: How are you?
+B: Fine.
+
+A: What's up?
+B: Not much. Just hanging out.
+```
+
+The model can produce surprisingly conversational responses despite its very small parameter count.
+
+## Architecture
+
+reFLEX moves away from the idea that every part of the system needs to be represented by a large attention-based language model.
+
+Its conceptual structure is:
+
+```text
+                 Input
+                   │
+                   ▼
+              ┌─────────┐
+              │ Intent  │
+              └────┬────┘
+                   │
+                   ▼
+              ┌─────────┐
+              │Experience│
+              └────┬────┘
+                   │
+                   ▼
+              ┌─────────┐
+              │  Main   │
+              │  Model  │
+              └────┬────┘
+                   │
+                   ▼
+                Response
+```
+
+The **Experience** component can be thought of as a lightweight helper that effectively says:
+
+> "These topics or pieces of information might be useful here."
+
+It is not intended to replace the main language model.
+
+## Parameter Distribution
+
+One of the notable properties of reFLEX-v1-15M is that the total parameter count is not divided evenly between its components.
+
+Approximately:
+
+* **Main:** 14M parameters
+* **Experience:** 0.8M parameters
+* **Intent:** 0.2M parameters
+
+This means the majority of the model's capacity remains dedicated to language generation, while relatively small components provide additional processing.
+
+## Intended Use
+
+reFLEX-v1-15M is intended for:
+
+* Experimental conversational AI
+* Research into modular language-model architectures
+* Studying small language models
+* Exploring retrieval/experience-assisted generation
+* Conversational behavior experiments
+* Educational experimentation with transformer architectures
+
+## Limitations
+
+reFLEX-v1-15M is **not** a general-purpose assistant.
+
+It has several important limitations:
+
+* It has very limited factual knowledge.
+* It can hallucinate heavily.
+* Responses may be grammatically incorrect or semantically unrelated.
+* It may produce abrupt or unusual responses.
+* It may repeat itself.
+* It may exhibit inconsistent conversational behavior.
+* Its responses can vary substantially between generations.
+* It was not trained to follow instructions reliably.
+* It should not be used for factual, medical, legal, financial, or safety-critical applications.
+
+The model's unusual conversational personality should be considered an **emergent property of the training and architecture**, not an indication of human-like understanding.
+
+## Conversational Behavior
+
+An interesting characteristic observed during testing is that reFLEX sometimes reacts differently depending on the **social tone** of an input.
+
+Informal testing produced behavior roughly resembling:
+
+| Input style | Observed behavior                  |
+| ----------- | ---------------------------------- |
+| Positive    | Dramatic / enthusiastic            |
+| Neutral     | Introverted / brief                |
+| Negative    | Defensive / sarcastic              |
+| Confusing   | Uncertain / existential            |
+| Commands    | Occasionally resistant or confused |
+
+These behaviors are **observations from experimentation, not guaranteed capabilities**.
+
+For example:
+
+```text
+A: You're pretty cool.
+B: No.
+```
+
+and:
+
+```text
+A: I appreciate the effort.
+B: You're an idiot.
+```
+
+The model can also produce unexpectedly ordinary conversational responses:
+
+```text
+A: What's up?
+B: Just got back from the park with my dog.
+```
+
+This makes reFLEX particularly interesting as a research experiment despite its extremely small size.
+
+## Experience Ablation
+
+Testing with and without the Experience component showed that Experience can substantially alter the generated response.
+
+However, because the model was not trained specifically as a factual QA system, activating Experience does **not** guarantee factual correctness.
+
+For this reason, Experience should be understood as a mechanism for influencing generation through contextual information rather than as a conventional knowledge database.
+
+## Generation
+
+A basic example using the `qreflex` package:
+
+```python
+from qreflex import reFLEX
+
+model = reFLEX(
+    directory=r"D:\QED\REFLEX\flex", # Or repo: qvx-o/reFLEX-v1-15M
+    from_pretrained=True, # if repo dont use
+    checkpoint_file=r"D:\QED\REFLEX\flex\reFLEX-v1-15M.pt", # if rpeo dont use
+)
+
+question = "What's up?"
+
+answer = model.generate(
+    f"A: {question}\nB:",
+    use_experience=True,
+    stop=["\nA: ", "\nB:"]
+)
+
+print(f"A: {question}\nB:", answer)
+```
+
+## Benchmarking
+
+A conversational benchmark was created specifically for reFLEX-v1-15M.
+
+The benchmark contains examples covering several conversational categories, including:
+
+* Greetings
+* Casual conversation
+* Positive statements
+* Affection
+* Commands
+* Negative statements
+* Criticism
+* Confusing inputs
+
+The benchmark is intended primarily to demonstrate **behavioral characteristics**, rather than conventional language-model performance.
+
+## Important Note
+
+reFLEX-v1-15M is intentionally small.
+
+Its purpose is not to demonstrate that a 15M model can compete with large language models on factual knowledge or general reasoning.
+
+Instead, reFLEX explores a different question:
+
+> **How much conversational behavior can emerge from a very small language model when some responsibilities are moved outside the main language generator?**
+
+The model is experimental, imperfect, and occasionally bizarre — but that is part of what makes it interesting.
+
+## Disclaimer
+
+**reFLEX-v1-15M is an experimental conversational model.**
+
+It may produce unexpected, sarcastic, dramatic, nonsensical, or otherwise strange responses. Do not interpret its outputs as authoritative information.